From 1adfc2f1b11a3d17ff269604e340aa4f4e5fff55 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 15 Sep 2021 17:08:16 +0100 Subject: [PATCH 01/29] Fix RDS bug --- plugins/modules/rds_instance.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/plugins/modules/rds_instance.py b/plugins/modules/rds_instance.py index c1f118db514..6fcacd37918 100644 --- a/plugins/modules/rds_instance.py +++ b/plugins/modules/rds_instance.py @@ -989,11 +989,10 @@ def get_changing_options_with_inconsistent_keys(modify_params, instance, purge_c def get_changing_options_with_consistent_keys(modify_params, instance): - inconsistent_parameters = list(modify_params.keys()) changing_params = {} for param in modify_params: - current_option = instance.get('PendingModifiedValues', {}).get(param) + current_option = instance.get('PendingModifiedValues', {}).get(param, None) if current_option is None: current_option = instance[param] if modify_params[param] != current_option: From f1717a484d385bbc34a3024ca7d46c6ee88b41e8 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 15 Sep 2021 17:15:50 +0100 Subject: [PATCH 02/29] add changelog --- changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml diff --git a/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml b/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml new file mode 100644 index 00000000000..2f7373c12e0 --- /dev/null +++ b/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml @@ -0,0 +1,2 @@ +bugfixes: +- rds_instance - Fixed issue with enabling enhanced monitoring on a pre-existing RDS instance (https://github.com/ansible-collections/community.aws/pull/712). From 2e6b3f0bdcf4f512ea7e47b86687a57ed85a7877 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 17 Sep 2021 11:23:22 +0100 Subject: [PATCH 03/29] add tests and make further bug fix tweak --- plugins/modules/rds_instance.py | 2 +- .../targets/rds_instance/inventory | 1 + .../roles/rds_instance/defaults/main.yml | 1 + .../enhanced_monitoring_assume_policy.json | 13 ++++ .../tasks/test_enhanced_monitoring.yml | 68 +++++++++++++++++++ 5 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json create mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml diff --git a/plugins/modules/rds_instance.py b/plugins/modules/rds_instance.py index 6fcacd37918..92d5e257cf0 100644 --- a/plugins/modules/rds_instance.py +++ b/plugins/modules/rds_instance.py @@ -994,7 +994,7 @@ def get_changing_options_with_consistent_keys(modify_params, instance): for param in modify_params: current_option = instance.get('PendingModifiedValues', {}).get(param, None) if current_option is None: - current_option = instance[param] + current_option = instance.get(param, None) if modify_params[param] != current_option: changing_params[param] = modify_params[param] diff --git a/tests/integration/targets/rds_instance/inventory b/tests/integration/targets/rds_instance/inventory index e19e0c76b3a..198a033504c 100644 --- a/tests/integration/targets/rds_instance/inventory +++ b/tests/integration/targets/rds_instance/inventory @@ -4,6 +4,7 @@ tags modification bad_options processor_features +enhanced_monitoring encryption final_snapshot read_replica diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml index 33760c64660..19654342a8b 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml @@ -8,6 +8,7 @@ storage_encrypted_db_instance_class: db.t3.small modified_db_instance_class: db.t3.medium allocated_storage: 20 modified_allocated_storage: 30 +monitoring_interval: 60 # For aurora tests cluster_id: "{{ resource_prefix }}-cluster" diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json b/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json new file mode 100644 index 00000000000..29acf369fc9 --- /dev/null +++ b/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json @@ -0,0 +1,13 @@ +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "monitoring.rds.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] +} diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml new file mode 100644 index 00000000000..90a415cda76 --- /dev/null +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -0,0 +1,68 @@ +--- +- block: + - name: Ensure the resource doesn't exist + rds_instance: + id: "{{ instance_id }}" + state: absent + skip_final_snapshot: True + register: result + + - assert: + that: + - not result.changed + ignore_errors: yes + + - name: Create a mariadb instance without enhanced monitoring + rds_instance: + id: "{{ instance_id }}" + state: present + engine: mariadb + engine_version: "{{ mariadb_engine_version }}" + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + register: result + + - assert: + that: + - result.changed + - "result.db_instance_identifier == '{{ instance_id }}'" + + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + + - name: Modify the instance immediately to enable enhanced monitoring + rds_instance: + id: "{{ instance_id }}" + state: present + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring.arn }}" + apply_immediately: True + register: result + + - assert: + that: + - result.changed + - 'result.monitoring_interval == "{{ monitoring_interval }}"' + + always: + - name: Delete the instance + rds_instance: + id: "{{ item }}" + state: absent + skip_final_snapshot: True + loop: + - "{{ instance_id }}" + - "{{ modified_instance_id }}" + ignore_errors: yes + + - name: Delete the role + iam_role: + name: "{{ instance_id }}-role" + state: absent From 01917383fb3843223e432c5b23fe20feb4c22cc2 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 17 Sep 2021 11:30:53 +0100 Subject: [PATCH 04/29] test update --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 90a415cda76..96cde7eb94c 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -54,12 +54,9 @@ always: - name: Delete the instance rds_instance: - id: "{{ item }}" + id: "{{ instance_id }}" state: absent skip_final_snapshot: True - loop: - - "{{ instance_id }}" - - "{{ modified_instance_id }}" ignore_errors: yes - name: Delete the role From 8530978d8bc611267b1e231b4cc3c973ee4b3fda Mon Sep 17 00:00:00 2001 From: Mark Woolley Date: Sat, 18 Sep 2021 12:28:46 +0100 Subject: [PATCH 05/29] correct test var --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 96cde7eb94c..fc7f1ed09eb 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -42,7 +42,7 @@ id: "{{ instance_id }}" state: present monitoring_interval: "{{ monitoring_interval }}" - monitoring_role_arn: "{{ enhanced_monitoring.arn }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" apply_immediately: True register: result From 9a36eed9f985be8f60ffba2d625a3a479104402a Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 20 Sep 2021 18:00:39 +0100 Subject: [PATCH 06/29] Enable tests --- tests/integration/targets/rds_instance/aliases | 4 ---- 1 file changed, 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/aliases b/tests/integration/targets/rds_instance/aliases index 283523234b9..4ef4b2067d0 100644 --- a/tests/integration/targets/rds_instance/aliases +++ b/tests/integration/targets/rds_instance/aliases @@ -1,5 +1 @@ -# reason: missing-policy -# reason: slow -unsupported - cloud/aws From fd62423551423d94fe05038cabff3937572aadee Mon Sep 17 00:00:00 2001 From: Mark Woolley Date: Mon, 27 Sep 2021 11:52:23 +0100 Subject: [PATCH 07/29] Update tests/integration/targets/rds_instance/aliases Co-authored-by: Mark Chappell --- tests/integration/targets/rds_instance/aliases | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/integration/targets/rds_instance/aliases b/tests/integration/targets/rds_instance/aliases index 4ef4b2067d0..e30a1801b1e 100644 --- a/tests/integration/targets/rds_instance/aliases +++ b/tests/integration/targets/rds_instance/aliases @@ -1 +1,3 @@ +slow + cloud/aws From 25fcc7ab243367a0e4f92c609333aa7d332f4de0 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 27 Sep 2021 11:53:13 +0100 Subject: [PATCH 08/29] try leaving out the iam deletion for enhanced monitoring --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index fc7f1ed09eb..66893d4caeb 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -58,8 +58,3 @@ state: absent skip_final_snapshot: True ignore_errors: yes - - - name: Delete the role - iam_role: - name: "{{ instance_id }}-role" - state: absent From ad931538314ee28e8d57c930d3a4e0236cc27285 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 27 Sep 2021 12:45:07 +0100 Subject: [PATCH 09/29] move IAM creation to earlier on --- .../tasks/test_enhanced_monitoring.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 66893d4caeb..d1201a7f755 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -12,6 +12,14 @@ - not result.changed ignore_errors: yes + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + - name: Create a mariadb instance without enhanced monitoring rds_instance: id: "{{ instance_id }}" @@ -29,14 +37,6 @@ - result.changed - "result.db_instance_identifier == '{{ instance_id }}'" - - name: Create an enhanced monitoring role - iam_role: - assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" - name: "{{ instance_id }}-role" - state: present - managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" - register: enhanced_monitoring_role - - name: Modify the instance immediately to enable enhanced monitoring rds_instance: id: "{{ instance_id }}" From c541e834ccbd0c0bbd6c0a13ff194425cd28b268 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 29 Sep 2021 12:35:21 +0100 Subject: [PATCH 10/29] The tests are exceeding a 1hr session limit - Condense tests where possible - Remove irrelevant snapshot tests - Up concurrency to 6 --- .../targets/rds_instance/inventory | 6 - .../integration/targets/rds_instance/main.yml | 2 +- .../rds_instance/tasks/test_bad_options.yml | 31 --- .../rds_instance/tasks/test_encryption.yml | 42 --- .../tasks/test_enhanced_monitoring.yml | 60 ----- .../tasks/test_final_snapshot.yml | 61 ----- .../rds_instance/tasks/test_modification.yml | 17 ++ .../rds_instance/tasks/test_snapshot.yml | 83 ------ .../roles/rds_instance/tasks/test_states.yml | 154 +++++++---- .../roles/rds_instance/tasks/test_tags.yml | 241 ------------------ 10 files changed, 116 insertions(+), 581 deletions(-) delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml diff --git a/tests/integration/targets/rds_instance/inventory b/tests/integration/targets/rds_instance/inventory index 198a033504c..47b2a44a6ab 100644 --- a/tests/integration/targets/rds_instance/inventory +++ b/tests/integration/targets/rds_instance/inventory @@ -1,16 +1,10 @@ [tests] states -tags modification -bad_options processor_features -enhanced_monitoring -encryption -final_snapshot read_replica vpc_security_groups restore_instance -snapshot # TODO: uncomment after adding rds_cluster module # aurora diff --git a/tests/integration/targets/rds_instance/main.yml b/tests/integration/targets/rds_instance/main.yml index fc2c909ec11..44695589af6 100644 --- a/tests/integration/targets/rds_instance/main.yml +++ b/tests/integration/targets/rds_instance/main.yml @@ -6,6 +6,6 @@ - hosts: all gather_facts: no strategy: free - serial: 5 + serial: 6 roles: - rds_instance diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml deleted file mode 100644 index 9fd2f4fa6e4..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a DB instance with an invalid engine - rds_instance: - id: "{{ instance_id }}" - state: present - engine: thisisnotavalidengine - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - ignore_errors: True - - - assert: - that: - - result.failed - - '"DB engine thisisnotavalidengine should be one of" in result.msg' diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml deleted file mode 100644 index 6c3e81494e5..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ storage_encrypted_db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - storage_encrypted: True - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - result.kms_key_id - - result.storage_encrypted == true - - always: - - - name: Delete DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml deleted file mode 100644 index d1201a7f755..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ /dev/null @@ -1,60 +0,0 @@ ---- -- block: - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create an enhanced monitoring role - iam_role: - assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" - name: "{{ instance_id }}-role" - state: present - managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" - register: enhanced_monitoring_role - - - name: Create a mariadb instance without enhanced monitoring - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - engine_version: "{{ mariadb_engine_version }}" - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - - name: Modify the instance immediately to enable enhanced monitoring - rds_instance: - id: "{{ instance_id }}" - state: present - monitoring_interval: "{{ monitoring_interval }}" - monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" - apply_immediately: True - register: result - - - assert: - that: - - result.changed - - 'result.monitoring_interval == "{{ monitoring_interval }}"' - - always: - - name: Delete the instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml deleted file mode 100644 index 922a008c353..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml +++ /dev/null @@ -1,61 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - name: Delete the DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - final_snapshot_identifier: "{{ instance_id }}" - register: result - - - assert: - that: - - result.changed - - "result.final_snapshot.db_instance_identifier == '{{ instance_id }}'" - - - name: Check that snapshot exists - rds_snapshot_info: - db_snapshot_identifier: "{{ instance_id }}" - register: result - - - assert: - that: - - "result.snapshots | length == 1" - - "result.snapshots.0.engine == 'mariadb'" - - always: - - name: Remove the snapshot - rds_snapshot: - db_snapshot_identifier: "{{ instance_id }}" - state: absent - ignore_errors: yes - - - name: Remove the DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index 03e49967cae..6aec1d4db77 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -14,6 +14,14 @@ - not result.changed ignore_errors: yes + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + - name: Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -100,6 +108,8 @@ # TODO: test modifying db_subnet_group_name, db_security_groups, db_parameter_group_name, option_group_name, # monitoring_role_arn, monitoring_interval, domain, domain_iam_role_name, cloudwatch_logs_export_configuration + # Test multiple modifications including enabling enhanced monitoring + - name: Modify several attributes rds_instance: id: '{{ instance_id }}' @@ -112,6 +122,8 @@ engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 apply_immediately: True @@ -125,6 +137,7 @@ - '"port" in result.pending_modified_values or result.endpoint.port == 1150' - '"db_instance_class" in result.pending_modified_values or result.db_instance_class == modified_db_instance_class' - '"engine_version" in result.pending_modified_values or result.engine_version == mariadb_engine_version_2' + - '"monitoring_interval" in result.pending_modified_values or result.monitoring_interval == monitoring_interval' - name: Idempotence modifying several pending attributes rds_instance: @@ -138,6 +151,8 @@ engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 register: result @@ -166,6 +181,8 @@ engine_version: "10.2.21" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 register: result diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml deleted file mode 100644 index 131f9753e88..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml +++ /dev/null @@ -1,83 +0,0 @@ ---- - - block: - - - name: Getting shared snapshots - rds_snapshot_info: - snapshot_type: "shared" - register: result - - - assert: - that: - - not result.changed - - result.cluster_snapshots is defined - - result.snapshots is defined - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: - Name: "{{ instance_id }}" - Created_by: Ansible rds_instance tests - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}'" - - "result.tags.Created_by == 'Ansible rds_instance tests'" - - - name: Getting public snapshots - rds_snapshot_info: - db_instance_identifier: "{{ instance_id }}" - snapshot_type: "public" - register: result - - - assert: - that: - - not result.changed - - result.cluster_snapshots is not defined - - result.snapshots is defined - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed - - # TODO ideally we test with an actual shared snapshot - but we'd need a second account - making tests fairly complicated? - - always: - - - name: Delete the instance - rds_instance: - id: "{{ item }}" - state: absent - skip_final_snapshot: True - loop: - - "{{ instance_id }}" - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml index 7b16f81a183..0fff73e7ca3 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml @@ -13,6 +13,25 @@ - not result.changed ignore_errors: yes + # Test invalid bad options + - name: Create a DB instance with an invalid engine + rds_instance: + id: "{{ instance_id }}" + state: present + engine: thisisnotavalidengine + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + register: result + ignore_errors: True + + - assert: + that: + - result.failed + - '"DB engine thisisnotavalidengine should be one of" in result.msg' + + # Test clean instance creation with good options - name: Check Mode - Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -22,6 +41,10 @@ password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" allocated_storage: "{{ allocated_storage }}" + storage_encrypted: True + tags: + Name: "{{ instance_id }}" + Created_by: Ansible rds_instance tests register: result check_mode: yes @@ -29,6 +52,7 @@ that: - result.changed + # Test creation, adding tags and enabling encryption - name: Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -38,14 +62,23 @@ password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" allocated_storage: "{{ allocated_storage }}" + storage_encrypted: True + tags: + Name: "{{ instance_id }}" + Created_by: Ansible rds_instance tests register: result - assert: that: - result.changed - "result.db_instance_identifier == '{{ instance_id }}'" + - "result.tags | length == 2" + - "result.tags.Name == '{{ instance_id }}'" + - "result.tags.Created_by == 'Ansible rds_instance tests'" + - result.kms_key_id + - result.storage_encrypted == true - - name: Idempotence + - name: Test impotency omitting tags rds_instance: id: '{{ instance_id }}' state: present @@ -60,6 +93,7 @@ that: - not result.changed - result.db_instance_identifier + - "result.tags | length == 2" - name: Idempotence with minimal options rds_instance: @@ -71,7 +105,60 @@ that: - not result.changed - result.db_instance_identifier + - "result.tags | length == 2" + + - name: Test tags are not purged if purge_tags is False + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + engine: mariadb + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + tags: {} + purge_tags: False + register: result + + - assert: + that: + - not result.changed + - "result.tags | length == 2" + + - name: Add a tag and remove a tag + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + tags: + Name: "{{ instance_id }}-new" + Created_by: Ansible rds_instance tests + purge_tags: True + register: result + + - assert: + that: + - result.changed + - "result.tags | length == 2" + - "result.tags.Name == '{{ instance_id }}-new'" + + - name: Remove all tags + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + engine: mariadb + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + tags: {} + register: result + + - assert: + that: + - result.changed + - not result.tags + # Test stopping / rebooting instances - name: Check Mode - stop the instance rds_instance: id: '{{ instance_id }}' @@ -161,73 +248,28 @@ that: - result.changed - - name: take a snapshot - rds_snapshot: - db_instance_identifier: '{{ instance_id }}' - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: present - wait: yes - - - name: take a snapshot - idempotence - rds_snapshot: - db_instance_identifier: '{{ instance_id }}' - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: present - register: result - - - assert: - that: - - not result.changed - - - name: check snapshot is ok - rds_snapshot_info: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - register: result - - - assert: - that: - - (result.snapshots | length) == 1 - - - name: remove a snapshot without wait - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' + # Test final snapshot on deletion + - name: Delete the DB instance + rds_instance: + id: "{{ instance_id }}" state: absent + final_snapshot_identifier: "{{ instance_id }}" register: result - assert: that: - result.changed + - "result.final_snapshot.db_instance_identifier == '{{ instance_id }}'" - - name: remove a snapshot without wait - idempotence - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: absent - wait: yes - register: result - - - assert: - that: - - not result.changed - - - name: remove a snapshot with wait - idempotence - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: absent - wait: yes - register: result - - - assert: - that: - - not result.changed - - - name: check snapshot is removed + - name: Check that snapshot exists rds_snapshot_info: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' + db_snapshot_identifier: "{{ instance_id }}" register: result - assert: that: - - not result.snapshots + - "result.snapshots | length == 1" + - "result.snapshots.0.engine == 'mariadb'" always: diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml deleted file mode 100644 index 353daec1f31..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml +++ /dev/null @@ -1,241 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: - Name: "{{ instance_id }}" - Created_by: Ansible rds_instance tests - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}'" - - "result.tags.Created_by == 'Ansible rds_instance tests'" - - - name: Test idempotence omitting tags - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - assert: - that: - - not result.changed - - "result.tags | length == 2" - - - name: Test tags are not purged if purge_tags is False - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: {} - purge_tags: False - register: result - - - assert: - that: - - not result.changed - - "result.tags | length == 2" - - - name: Add a tag and remove a tag - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - tags: - Name: "{{ instance_id }}-new" - Created_by: Ansible rds_instance tests - purge_tags: True - register: result - - - assert: - that: - - result.changed - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}-new'" - - - name: Remove all tags - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: {} - register: result - - - assert: - that: - - result.changed - - not result.tags - - - name: snapshot instance without tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - wait: yes - register: result - - - assert: - that: - - result.changed - - not result.tags - - - name: add tags to snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - two: world - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - - name: add tags to snapshot - idempotence - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - two: world - register: result - - - assert: - that: - - not result.changed - - result.tags | length == 2 - - - name: add tag to snapshot using purge_tags False - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - purge_tags: False - register: result - - - assert: - that: - - result.changed - - result.tags | length == 3 - - - name: rerun tags but not setting purge_tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - - name: rerun tags but not setting purge_tags - idempotence - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - register: result - - - assert: - that: - - not result.changed - - result.tags | length == 2 - - - name: remove snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: absent - wait: yes - register: result - - - assert: - that: - - result.changed - - - name: create snapshot with tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - purge_tags: yes - wait: yes - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - always: - - - name: tidy up snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: absent - ignore_errors: yes - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed From 98d9cb34da2a838d72478f16cdea4b917856067f Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 15:51:29 +0100 Subject: [PATCH 11/29] PR feedback --- .../rds_instance/roles/rds_instance/defaults/main.yml | 1 + .../roles/rds_instance/tasks/test_modification.yml | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml index 19654342a8b..2e09597d4ec 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml @@ -9,6 +9,7 @@ modified_db_instance_class: db.t3.medium allocated_storage: 20 modified_allocated_storage: 30 monitoring_interval: 60 +preferred_maintenance_window: "mon:06:20-mon:06:50" # For aurora tests cluster_id: "{{ resource_prefix }}-cluster" diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index 6aec1d4db77..ac76d9d999d 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -28,6 +28,7 @@ state: present engine: mariadb engine_version: "{{ mariadb_engine_version }}" + allow_major_version_upgrade: true username: "{{ username }}" password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" @@ -118,7 +119,7 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "mon:06:20-mon:06:50" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false @@ -147,7 +148,7 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "mon:06:20-mon:06:50" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false @@ -177,8 +178,8 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "Mon:06:20-Mon:06:50" - engine_version: "10.2.21" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" + engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false monitoring_interval: "{{ monitoring_interval }}" From f177d0b0a240e5b522f830a64560178a750b9b7e Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 15:56:46 +0100 Subject: [PATCH 12/29] disable wait on final delete --- .../rds_instance/roles/rds_instance/tasks/test_aurora.yml | 2 ++ .../roles/rds_instance/tasks/test_modification.yml | 1 + .../roles/rds_instance/tasks/test_processor_features.yml | 1 + .../roles/rds_instance/tasks/test_read_replica.yml | 2 ++ .../roles/rds_instance/tasks/test_restore_instance.yml | 2 ++ .../rds_instance/roles/rds_instance/tasks/test_states.yml | 3 ++- .../roles/rds_instance/tasks/test_vpc_security_groups.yml | 4 ++++ 7 files changed, 14 insertions(+), 1 deletion(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml index c3a880d6bb1..031d0b8464e 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml @@ -113,6 +113,7 @@ id: "{{ item }}" state: absent skip_final_snapshot: True + wait: false loop: - "{{ instance_id }}" - "{{ modified_instance_id }}" @@ -123,4 +124,5 @@ cluster_id: "{{ cluster_id }}" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index ac76d9d999d..b2aa881cc43 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -219,5 +219,6 @@ id: '{{ item }}' state: absent skip_final_snapshot: True + wait: false loop: ['{{ instance_id }}', '{{ modified_instance_id }}'] ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml index 78dd44be4f0..a969f51debe 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml @@ -104,6 +104,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result - assert: diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml index 4aee2687d31..7ca19747dde 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml @@ -137,6 +137,7 @@ state: absent skip_final_snapshot: True region: "{{ region_src }}" + wait: false ignore_errors: yes - name: Remove the DB replica @@ -145,4 +146,5 @@ state: absent skip_final_snapshot: True region: "{{ region_dest }}" + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml index 64a948211c3..e8355299111 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml @@ -70,6 +70,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes @@ -78,4 +79,5 @@ id: "{{ instance_id }}-point-in-time" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml index 0fff73e7ca3..b3c06245315 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml @@ -277,7 +277,7 @@ rds_snapshot: db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' state: absent - wait: yes + wait: false ignore_errors: yes - name: Remove DB instance @@ -285,4 +285,5 @@ id: '{{ instance_id }}' state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml index 940ce5b0fae..917b8c430af 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml @@ -145,6 +145,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result ignore_errors: yes @@ -153,6 +154,7 @@ name: "{{ item }}" description: "created by rds_instance integration tests" state: absent + wait: false register: sgs_result loop: - "{{ resource_prefix }}-sg-1" @@ -168,6 +170,7 @@ Name: "{{ resource_prefix }}-subnet" Description: "created by rds_instance integration tests" state: absent + wait: false register: subnets ignore_errors: yes retries: 30 @@ -198,5 +201,6 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result ignore_errors: yes From cb55043483d49a4ea24aee7aac1c93e8a4b03087 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 16:05:41 +0100 Subject: [PATCH 13/29] further adjust --- .../roles/rds_instance/tasks/test_modification.yml | 12 ------------ .../rds_instance/tasks/test_restore_instance.yml | 1 - 2 files changed, 13 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index b2aa881cc43..e162509d549 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -200,18 +200,6 @@ - '"db_instance_class" in result.pending_modified_values or result.db_instance_class == "db.t2.medium"' - '"engine_version" in result.pending_modified_values or result.engine_version == "10.2.21"' - - name: Delete the instance - rds_instance: - id: '{{ instance_id }}' - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed - - '"pending_modified_values" not in result' - always: - name: Delete the instance diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml index e8355299111..7816cbcce11 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml @@ -73,7 +73,6 @@ wait: false ignore_errors: yes - - name: Remove the point in time restored DB rds_instance: id: "{{ instance_id }}-point-in-time" From 8d9aacc5c9655dea2483c08dc37948486fe94cbe Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 8 Oct 2021 09:30:02 +0100 Subject: [PATCH 14/29] Squashed commit of the following: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit commit 11ac4437d38202696bd0d3e1791f290dffa1a9d2 Merge: c16440c 19e60c2 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Oct 1 05:49:58 2021 -0700 Merge pull request #739 from tremble/sns_topic/httpretry_strings sns_topic - Define shape for delivery_policy. SUMMARY delivery_policy was previously defined just as "dict", this meant that if someone passed in JSON or quoted the numbers, AWS would spit errors at them. By defining the shape of delivery_policy Ansible will automatically convert "10" to 10, as well as providing cleaner error messages for missing components of the policy. ISSUE TYPE Bugfix Pull Request COMPONENT NAME sns_topic ADDITIONAL INFORMATION obsoletes #716 Reviewed-by: Alina Buzachis Reviewed-by: None commit c16440cf2a28a9f911cb6ba70ce93e950bf2e19c Merge: d35601e f8fb040 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Oct 1 11:57:13 2021 +0000 Merge pull request #740 from tremble/tests/config Add tests config file to specificaly state that we're not interested in python < 3.6 SUMMARY With Ansible 2.12 ansible-test supports explicitly defining the python version supported by a collection ISSUE TYPE Feature Pull Request COMPONENT NAME sanity tests ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: None commit 19e60c2713946979725a82dd05d588f0bf993c93 Author: Mark Chappell Date: Fri Oct 1 13:20:57 2021 +0200 changelog commit f8fb040cfdad8254814a9437ac285546c7757c8f Author: Mark Chappell Date: Thu Sep 30 14:44:50 2021 +0200 Add tests config file to specificaly state that we're not interested in python < 3.6 commit d35601ea6160c2a1f6635a894809c9cdb81ddeff Merge: 4babc11 f052df6 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 30 11:31:31 2021 +0000 Merge pull request #735 from tremble/iam_cert/files Deprecate passing file names to the iam_server_certificate module SUMMARY iam_server_certificate currently accepts file names (or content) in the cert, chain_cert and key options. Since the module directly uses open(). This will perform a 'remote' lookup with unexpected results for relative file paths. Encourage the use of lookups so that the behaviour will at least be predictable. ISSUE TYPE Feature Pull Request COMPONENT NAME iam_server_certificate ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell Reviewed-by: None commit 99238d146577df996f139c39368e49aca2e74f1c Author: Mark Chappell Date: Thu Sep 30 12:01:21 2021 +0200 sns_topic - Define shape for delivery_policy. commit 8d639c61d9039daae83415a206236c8cd6878f81 Author: Mark Chappell Date: Thu Sep 30 08:59:44 2021 +0200 Add integration test commit 4babc110457fea1b8b54e9beea388bcc07e66c0d Merge: 3fbca8f fb38343 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Wed Sep 29 20:03:08 2021 +0000 Merge pull request #595 from kbrebanov/fix-route53-identifier route53: Identifier missing from resource_record_set. SUMMARY Currently, the identifier parameter is never included in resource_record_set. ISSUE TYPE Bugfix Pull Request COMPONENT NAME route53 ADDITIONAL INFORMATION The identifier parameter is always nullified as it's not included in resource_record_set. This change allows the identifier to be included and scrubbed if None. Reviewed-by: Mark Chappell Reviewed-by: None commit fb3834327475a283cc80e30717d2bff16ab4ea53 Author: Mark Chappell Date: Wed Sep 29 20:33:10 2021 +0200 Add integration tests commit 83dd7bae9d2980b019abc416cd782cb65d19ff46 Author: Kevin Brebanov Date: Thu Sep 16 16:00:06 2021 -0400 Add changelog fragment for pull request #595 commit e038cb304c4697915d6c129f985aa372df834096 Author: Kevin Brebanov Date: Mon Jun 7 10:41:05 2021 -0400 route53: Prevent identifier from always being scrubbed. commit f052df63189fa5961b6926bd6ff548d1bd23b489 Author: Mark Chappell Date: Mon Sep 27 09:44:38 2021 +0200 changelog commit cd42d4362ea514f9d8409d522ffc48ca5de4821f Author: Mark Chappell Date: Mon Sep 27 09:26:23 2021 +0200 Deprecate passing file names to the iam_server_certificate module commit 3fbca8f069dd583089d3e4eaedaa1f542306fc65 Merge: 0769e8e dddd547 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Tue Sep 28 12:48:14 2021 +0000 Merge pull request #738 from Andersson007/test_1 Copy ignore-2.12.txt to ignore-2.13.txt SUMMARY Relates to ansible-collections/overview#45 (comment) Reviewed-by: Mark Chappell Reviewed-by: Alina Buzachis Reviewed-by: None commit dddd547069c11e34ef3a9f9dfa5f95799f67ae33 Author: Andrew Klychkov Date: Tue Sep 28 13:44:04 2021 +0200 Copy ignore-2.12.txt to ignore-2.13.txt commit 0769e8e30b1922dd60149e035f9b406e83dc3119 Merge: 4c6f54b 395b77a Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Sep 24 18:19:57 2021 +0000 Merge pull request #670 from alinabuzachis/elb_target_group/preserve_client_ip_enabled elb_target_group - add preserve_client_ip_enabled and proxy_protocol_v2_enabled options SUMMARY elb_target_group - add preserve_client_ip_enabled and proxy_protocol_v2_enabled options Fixes #555 ISSUE TYPE Feature Pull Request COMPONENT NAME elb_target_group.py Reviewed-by: Mark Chappell Reviewed-by: None commit 4c6f54bd6db81fdf6e3e4066c6bf0fc0e3270213 Merge: 85dffb3 4f44d69 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Sep 24 13:38:10 2021 +0000 Merge pull request #702 from doticatto/patch-1 Undocumented IOPS return IOPS is being returned by the module, but simply was not documented. Simply a documentation change. ISSUE TYPE Docs Pull Request Reviewed-by: Alina Buzachis Reviewed-by: Markus Bergholz Reviewed-by: None commit 85dffb3489ebf51b30ae4774df98c24f349a9a29 Merge: a55b7a9 59deefe Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Sep 24 13:09:36 2021 +0000 Merge pull request #707 from boutetnico/add-cf-ssl-version cloudfront_distribution: add new security policy version TLSv1.2_2021 SUMMARY Add new TLSv1.2_2021 security policy for CloudFront viewer connections. ISSUE TYPE Feature Pull Request COMPONENT NAME cloudfront_distribution ADDITIONAL INFORMATION https://aws.amazon.com/about-aws/whats-new/2021/06/amazon-cloudfront-announces-new-tlsv12_2021-security-policy-for-viewer-connections/ Reviewed-by: Alina Buzachis Reviewed-by: Markus Bergholz Reviewed-by: None commit 395b77a88b4dd3f32b1940881ecc6b29f97ff8b1 Author: Mark Chappell Date: Fri Sep 24 14:49:59 2021 +0200 bump version added - missed the 2.0.0 release commit 5d0b57eb9549082d2a98ad51f6bffe4bc7d7184c Author: Alina Buzachis Date: Tue Jul 20 16:03:48 2021 +0200 elb_target - add preserve_client_ip_enabled ond proxy_protocol_v2_enabled ptions Signed-off-by: Alina Buzachis commit a55b7a92b31f81ced3e36f8acb4b335af22ade11 Merge: 0954679 093aa24 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Sep 24 12:22:23 2021 +0000 Merge pull request #731 from tremble/eip_unbound Fix EIP allocation with in_vpc not set SUMMARY Our integration tests were setting in_vpc (because most use-cases need it) so we missed that setting the minimum possible configuration for an EIP resulted in an exception: ec2_eip: state: present in_vpc: '{{ omit }}' task path: /root/ansible_collections/community/aws/tests/output/.tmp/integration/ec2_eip-hkuj00lj-ÅÑŚÌβŁÈ/tests/integration/targets/ec2_eip/tasks/main.yml:666 ESTABLISH LOCAL CONNECTION FOR USER: root EXEC /bin/sh -c 'echo ~root && sleep 0' EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /root/.ansible/tmp `"&& mkdir "` echo /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289 `" && echo ansible-tmp-1632477941.356962-3535-26932306567289="` echo /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289 `" ) && sleep 0' Using module file /root/ansible_collections/community/aws/plugins/modules/ec2_eip.py PUT /root/.ansible/tmp/ansible-local-1077my3ghuvo/tmp0lqxcnwq TO /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289/AnsiballZ_ec2_eip.py EXEC /bin/sh -c 'chmod u+x /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289/ /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289/AnsiballZ_ec2_eip.py && sleep 0' EXEC /bin/sh -c 'ANSIBLE_DEBUG_BOTOCORE_LOGS=True /usr/bin/python3.9 /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289/AnsiballZ_ec2_eip.py && sleep 0' EXEC /bin/sh -c 'rm -f -r /root/.ansible/tmp/ansible-tmp-1632477941.356962-3535-26932306567289/ > /dev/null 2>&1 && sleep 0' The full traceback is: Traceback (most recent call last): File "/tmp/ansible_ec2_eip_payload_rqxrzx_j/ansible_ec2_eip_payload.zip/ansible_collections/community/aws/plugins/modules/ec2_eip.py", line 376, in allocate_address File "/tmp/ansible_ec2_eip_payload_rqxrzx_j/ansible_ec2_eip_payload.zip/ansible_collections/amazon/aws/plugins/module_utils/core.py", line 334, in deciding_wrapper return retrying_wrapper(*args, **kwargs) File "/tmp/ansible_ec2_eip_payload_rqxrzx_j/ansible_ec2_eip_payload.zip/ansible_collections/amazon/aws/plugins/module_utils/cloud.py", line 118, in _retry_wrapper return _retry_func( File "/tmp/ansible_ec2_eip_payload_rqxrzx_j/ansible_ec2_eip_payload.zip/ansible_collections/amazon/aws/plugins/module_utils/cloud.py", line 68, in _retry_func return func() File "/usr/local/lib/python3.9/dist-packages/botocore/client.py", line 337, in _api_call return self._make_api_call(operation_name, kwargs) File "/usr/local/lib/python3.9/dist-packages/botocore/client.py", line 628, in _make_api_call request_dict = self._convert_to_request_dict( File "/usr/local/lib/python3.9/dist-packages/botocore/client.py", line 676, in _convert_to_request_dict request_dict = self._serializer.serialize_to_request( File "/usr/local/lib/python3.9/dist-packages/botocore/validate.py", line 297, in serialize_to_request raise ParamValidationError(report=report.generate_report()) botocore.exceptions.ParamValidationError: Parameter validation failed: Invalid type for parameter Domain, value: None, type: , valid types: fatal: [testhost]: FAILED! => { "boto3_version": "1.15.0", "botocore_version": "1.18.0", "changed": false, "invocation": { "module_args": { "allow_reassociation": false, "aws_access_key": "AKIAQAEICK57ETHUOKNO", "aws_ca_bundle": null, "aws_config": null, "aws_secret_key": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "debug_botocore_endpoint_logs": true, "device_id": null, "ec2_url": null, "in_vpc": false, "private_ip_address": null, "profile": null, "public_ip": null, "public_ipv4_pool": null, "region": "us-east-1", "release_on_disassociation": false, "reuse_existing_ip_allowed": false, "security_token": null, "state": "present", "tag_name": null, "tag_value": null, "validate_certs": true, "wait_timeout": null } }, "msg": "Couldn't allocate Elastic IP address: Parameter validation failed:\nInvalid type for parameter Domain, value: None, type: , valid types: ", "resource_actions": [] } ISSUE TYPE Bugfix Pull Request COMPONENT NAME ec2_eip ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell Reviewed-by: None commit 093aa24a1417a79148df9fdf3373ca45063f7d3d Author: Mark Chappell Date: Fri Sep 24 13:22:30 2021 +0200 Update changelogs/fragments/731-ec2_eip-not_in_vpc.yml commit e018caefd8d563563253addf88e5ded33cf4d9ad Author: Mark Chappell Date: Fri Sep 24 12:15:11 2021 +0200 Changelog commit 0091444a65bfbf8a0f66067aea5bde0740e92444 Author: Mark Chappell Date: Fri Sep 24 12:10:08 2021 +0200 Fix bug when allocating an EIP with in_vpc not set commit 78fc2db988f7a882590032e01046cb20b2a538cc Author: Mark Chappell Date: Fri Sep 24 12:06:51 2021 +0200 Add integration test commit 0954679f3c35010193959908df50239d7e2a36b2 Merge: f9654cf df28789 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 23 10:51:48 2021 +0000 Merge pull request #728 from tremble/rename/iam_cert Rename iam_cert to iam_server_certificate for consistency SUMMARY iam_cert (and what used to be known as iam_cert_facts) only deal with "server" certificates (AWS also has a CA cert offering in IAM) with the big 2.9 _fact rename iam_cert_facts was renamed to iam_server_certificate_info. (more tests and a migration to boto3 to follow) ISSUE TYPE Feature Pull Request COMPONENT NAME iam_cert ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: None commit df287897c69cdfc307b3c05d9f943945026fbbb2 Author: Mark Chappell Date: Thu Sep 23 10:46:27 2021 +0200 Rename iam_cert to iam_server_certificate for consistency commit f9654cf9f8b5bb697d410c6986f2a9b1ba3735c3 Merge: ee984b2 861c966 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 23 08:54:50 2021 +0000 Merge pull request #724 from tremble/boto3/redshift_subnet_group Migrate redshift_subnet_group to boto3 SUMMARY Migrate redshift_subnet_group to boto3 note: while there additional features (tagging springs to mind) that could be added, I'm trying to avoid scope creep and mostly just want to knock out migrations of the remaining old-boto modules. That said, I am converting tags using the boto3_tag_list_to_ansible_dict helper, in the return values this is just to avoid needing to change formats in future ISSUE TYPE Feature Pull Request COMPONENT NAME redshift_subnet_group ADDITIONAL INFORMATION Depends-On: #719 Reviewed-by: Markus Bergholz Reviewed-by: Alina Buzachis Reviewed-by: None commit 861c9665d79b44137542dfea9cdf926684f50252 Author: Mark Chappell Date: Thu Sep 23 09:10:45 2021 +0200 changelog commit 451bef72306b8c62212dc44e553d7bd43d9fbf63 Author: Mark Chappell Date: Sat Sep 18 10:13:55 2021 +0200 Add documentation and support for check_mode commit aac8190f737173247f871c57196dea58f65a1f9e Author: Mark Chappell Date: Sat Sep 18 09:59:28 2021 +0200 Add additional tests and documentation around new return values commit dc4cd6e116b55baf9a8ae0838dfb56daee4d4a79 Author: Mark Chappell Date: Sat Sep 18 09:12:11 2021 +0200 Add additional tests for minimal/partial parameters. commit c21eac881a3513995b11eb4200c7b21900d5579e Author: Mark Chappell Date: Fri Sep 17 23:56:02 2021 +0200 Migrate redshift_subnet_group to boto3 commit ee984b2b972275bbc4e6a011ed9046d497689e16 Merge: 0ed628a 402b472 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 23 00:06:44 2021 +0000 Merge pull request #715 from jillr/2_0_0_prep Prepare 2.0.0 release SUMMARY Prepare 2.0.0 release. Run add_docs, generate changelog, update versions ISSUE TYPE Feature Pull Request COMPONENT NAME community.aws Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell Reviewed-by: Jill R Reviewed-by: Markus Bergholz Reviewed-by: Gonéri Le Bouder Reviewed-by: None commit 402b4721d391c890dab2cae500a5342f54bd0c69 Author: jillr Date: Tue Sep 21 18:44:50 2021 +0000 refresh docs commit 398badfda62ebe98b1c8c05370384651a75df824 Author: jillr Date: Thu Sep 16 17:54:21 2021 +0000 refresh fragments and docs commit 49b2618f80de984f2d5137d4b9201d0c84b7f8a4 Author: jillr Date: Wed Sep 15 21:46:41 2021 +0000 Prepare 2.0.0 release commit 0ed628ad1290b0b1918e08e5b47ad41a5c601a90 Merge: 7672e7d 7c7b028 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Wed Sep 22 16:01:49 2021 +0000 Merge pull request #719 from tremble/tests/redshift_subnet_group Add integration tests for redshift_subnet_group SUMMARY Add integration tests for redshift_subnet_group CI / IAM Permissions ISSUE TYPE Feature Pull Request COMPONENT NAME redshift_subnet_group ADDITIONAL INFORMATION Reviewed-by: None commit 7672e7d0e5cc13b879d0e9758b494a9f709968f0 Merge: 2defed0 d779a7b Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Mon Sep 20 15:11:18 2021 +0000 Merge pull request #723 from tremble/boto3/elasticache_subnet_group Migrate elasticache_subnet_group to boto3 SUMMARY Migrate elasticache_subnet_group to boto3 note: while there additional features (tagging springs to mind) that could be added, I'm trying to avoid scope creep and mostly just want to knock out migrations of the remaining old-boto modules. ISSUE TYPE Feature Pull Request COMPONENT NAME elasticache_subnet_group ADDITIONAL INFORMATION Depends-On: #720 Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell Reviewed-by: None commit 2defed0c79c45ebb3eab4cced19322fcd392134c Merge: e125e89 002b237 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Mon Sep 20 09:28:58 2021 +0000 Merge pull request #725 from tremble/tests/dynamodb_table Integration tests for dynamodb SUMMARY Integration tests for dynamodb There's a lot of commented out tests, the current module's really inconsistent about return values and the "defaults" result in various settings being reset. The current module also handles a number of temporary failures poorly (hence a lot of retry/until in the tests). ISSUE TYPE Feature Pull Request COMPONENT NAME dynamodb ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: None commit 002b23719dd324a147c9b1873ac92869f99f05b5 Author: Mark Chappell Date: Sat Sep 18 21:10:40 2021 +0200 Integration tests for dynamodb commit d779a7bc601dbd943a4466cea6a1d0b1e841f875 Author: Mark Chappell Date: Sat Sep 18 08:36:41 2021 +0200 Test creation with no description provided commit 8db0ada7873c90f2adb3e4dcf6fbce2831d0562c Author: Mark Chappell Date: Sat Sep 18 08:35:38 2021 +0200 Fail cleanly if no subnets are provided on creation. commit e6804cefe6650b559af56b72dc304ebc9c82b66b Author: Mark Chappell Date: Fri Sep 17 20:48:03 2021 +0200 Add support for check_mode commit 24c82110fc9c713f2845ceb3c6beef7b9eebcbc6 Author: Mark Chappell Date: Fri Sep 17 22:06:13 2021 +0200 Add documentation and tests for return values commit 3cb67e4ece6b25f355903d91abbb52fc51ad3697 Author: Mark Chappell Date: Fri Sep 17 20:38:34 2021 +0200 Migrate elasticache_subnet_group to boto3 commit e125e899b26b151d6a87b1543f90fce5cf89fa8f Merge: 095d4e4 7e14f92 Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Fri Sep 17 19:46:15 2021 +0000 Merge pull request #720 from tremble/tests/elasticache_subnet_group Split elasticache_subnet_group integration tests out SUMMARY In preparation for rewriting elasticache_subnet_group using boto3 split out the integration tests and exercise it slightly more. ISSUE TYPE Feature Pull Request COMPONENT NAME elasticache_subnet_group ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz Reviewed-by: Alina Buzachis Reviewed-by: None commit 7e14f922622bcad31f87bbc6ac865aeb6a9c0558 Author: Mark Chappell Date: Thu Sep 16 21:52:09 2021 +0200 Split elasticache_subnet_group out commit 7c7b02822ac030c31b290206fa7a65f3d4a51e4b Author: Mark Chappell Date: Thu Sep 16 18:03:30 2021 +0200 Add integration tests for redshift_subnet_group commit 095d4e474bf33a8486b1a604d3aae799934aa5ac Merge: 97972e0 0a9551d Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 16 15:50:14 2021 +0000 Merge pull request #644 from tremble/boto_versions Add constraints and requirements for unit/integration tests SUMMARY Now that we state that we support specific minimum versions of the AWS SDKs, make sure we base our unit/integration tests against them such that modules need to explicitly test/request newer versions of the SDKs. ISSUE TYPE Feature Pull Request COMPONENT NAME tests/integration tests/unit ADDITIONAL INFORMATION Depends-On: ansible-collections/amazon.aws#461 see also: ansible/ansible-zuul-jobs#991 see also: ansible-collections/amazon.aws#404 Reviewed-by: Alina Buzachis Reviewed-by: None commit 97972e0ae843a41d38a902deb006f9e84105c804 Merge: 8025686 0b5d1be Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 16 14:12:37 2021 +0000 Merge pull request #717 from tremble/tests/setup_roles Add setup_botocore_pip/ setup_ec2_facts/ setup_sshkey/ integration test helpers from amazon.aws SUMMARY Various components of the integration tests have been refactored to aid in consistency. Bring the helper modules over from amazon.aws ISSUE TYPE Feature Pull Request COMPONENT NAME tests/integration ADDITIONAL INFORMATION Original PRs (https://github.com/ansible-collections/amazon.aws/pull/): 427 485 481 498 Reviewed-by: None commit 0a9551d7ddeddb36ec485d409d9fc4238d90dba7 Author: Mark Chappell Date: Fri Jul 16 15:47:40 2021 +0200 Add constraints and requirements for unit/integration tests consistent with the minimum versions of the AWS SDK we explicitly state we support commit 0b5d1be37e13c74a6fe8649e15618ac84963ca57 Author: Mark Chappell Date: Thu Sep 16 12:07:38 2021 +0200 Add setup_botocore_pip/ setup_ec2_facts/ setup_sshkey/ integration test helpers from amazon.aws commit 8025686143a969f68bd5e786c41ca346355d02ca Merge: 19cc031 f5d98ba Author: ansible-zuul[bot] <48994755+ansible-zuul[bot]@users.noreply.github.com> Date: Thu Sep 16 06:22:34 2021 +0000 Merge pull request #711 from tremble/botocore/1.18.0 Bump botocore/boto3 requirements prior to release of 2.0.0 SUMMARY Follow up to ansible-collections/amazon.aws#502 We've bumped our minimum requirements in anticipation of release 2.0.0 ISSUE TYPE Feature Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: None commit f5d98baee4c24ca7f92cd67578fbf5bbd293cd96 Author: Mark Chappell Date: Wed Sep 15 06:44:54 2021 +0200 Bump botocore/boto3 requirements prior to release of 2.0.0 commit 4f44d696e499efab3aec4131a822888c8b216e27 Author: John Mahoney Date: Tue Sep 14 16:23:03 2021 -0400 Removed rst changes b/c autogenerated commit 59deefefe92fdb6dc0fb77f5ea954735a54dff10 Author: Nicolas Boutet Date: Thu Sep 9 10:30:04 2021 +0200 Add changelog fragment commit 9156837f93ef86972adab9e4bd83157a75c994c5 Author: Nicolas Boutet Date: Thu Sep 9 10:23:56 2021 +0200 cloudfront_distribution: add new cipher version TLSv1.2_2021 commit fea75df6504cb1a5879b510243ce57ce7d0491f5 Author: John Mahoney Date: Thu Sep 2 16:30:12 2021 -0400 Update community.aws.rds_instance_info_module.rst commit 64fc073d467a53dea5a2b04784c629b487334126 Author: John Mahoney Date: Thu Sep 2 16:11:50 2021 -0400 Undocumented IOPS return IOPS is being returned by the module, but simply was not documented. --- CHANGELOG.rst | 120 ++ README.md | 16 +- bindep.txt | 4 + changelogs/changelog.yaml | 219 ++++ changelogs/fragments/0-copy_ignore_txt.yml | 3 + ...-elb-module-add-ip_address_type_option.yml | 4 - ..._instance-preferred_maintenance_window.yml | 2 - changelogs/fragments/564-route53-retries.yml | 6 - .../574-ecs_taskdefinition-improvement.yml | 3 - changelogs/fragments/586-elb-renames.yml | 8 - .../fragments/592-sqs_queue-idempotent.yml | 2 - .../fragments/595-fix-route53-identifer.yaml | 2 + ...s-task-defination-env-file-validations.yml | 2 - .../fragments/614-ec2_vpc_peer-tagging.yml | 4 - .../616-ec2_vpc_route_table-tagging.yml | 4 - changelogs/fragments/629-imports-cleanup.yml | 2 - changelogs/fragments/648-kms_info.yml | 4 - changelogs/fragments/659-checkmode.yml | 10 - changelogs/fragments/663-deprecate-rds.yml | 3 - changelogs/fragments/664-deprecate-iam.yml | 3 - .../670-elb_target_group-new_attriibutes.yml | 3 + changelogs/fragments/675-boto3-minimums.yml | 26 - .../681-aws_secret-deletion-idempotency.yml | 2 - .../682-aws_s3_bucket_info-botocore.yml | 2 - changelogs/fragments/686-pylint.yml | 4 - changelogs/fragments/688-pylint.yml | 10 - .../692-s3_sync-individual-file-path.yml | 2 - ...-UpdateRoleDescription-with-UpdateRole.yml | 2 - ...d-cloudfront-new-security-policy-2021.yaml | 2 + .../724-redshift_subnet_group-boto3.yml | 7 + changelogs/fragments/728-iam_cert.yml | 3 + .../fragments/731-ec2_eip-not_in_vpc.yml | 2 + .../735-iam_server_certificate-file-names.yml | 3 + .../739-sns_topic-delivery_policy-shape.yml | 2 + .../fragments/deprecate_ec2_inv_script.yml | 2 - changelogs/fragments/migrate_ec2_instance.yml | 3 - .../fragments/migrate_ec2_vpc_endpoint.yml | 13 - changelogs/fragments/migrate_ec2_vpc_igw.yml | 10 - .../fragments/migrate_ec2_vpc_nat_gateway.yml | 10 - .../fragments/rename-connection-retries.yml | 2 - changelogs/fragments/sns_topic_type.yml | 2 - docs/community.aws.aws_acm_info_module.rst | 24 +- docs/community.aws.aws_acm_module.rst | 24 +- docs/community.aws.aws_api_gateway_module.rst | 24 +- ....aws_application_scaling_policy_module.rst | 26 +- ...s.aws_batch_compute_environment_module.rst | 24 +- ...ty.aws.aws_batch_job_definition_module.rst | 24 +- ...mmunity.aws.aws_batch_job_queue_module.rst | 24 +- docs/community.aws.aws_codebuild_module.rst | 25 +- docs/community.aws.aws_codecommit_module.rst | 25 +- .../community.aws.aws_codepipeline_module.rst | 25 +- ...onfig_aggregation_authorization_module.rst | 25 +- ...unity.aws.aws_config_aggregator_module.rst | 25 +- ...aws.aws_config_delivery_channel_module.rst | 25 +- ...mmunity.aws.aws_config_recorder_module.rst | 25 +- docs/community.aws.aws_config_rule_module.rst | 25 +- ...rect_connect_confirm_connection_module.rst | 25 +- ...s.aws_direct_connect_connection_module.rst | 25 +- ....aws.aws_direct_connect_gateway_module.rst | 24 +- ..._connect_link_aggregation_group_module.rst | 25 +- ...irect_connect_virtual_interface_module.rst | 25 +- docs/community.aws.aws_eks_cluster_module.rst | 25 +- ...ty.aws.aws_elasticbeanstalk_app_module.rst | 23 +- ...mmunity.aws.aws_glue_connection_module.rst | 24 +- docs/community.aws.aws_glue_job_module.rst | 24 +- ...munity.aws.aws_inspector_target_module.rst | 25 +- docs/community.aws.aws_kms_info_module.rst | 47 +- docs/community.aws.aws_kms_module.rst | 23 +- docs/community.aws.aws_msk_cluster_module.rst | 1031 +++++++++++++++++ docs/community.aws.aws_msk_config_module.rst | 435 +++++++ docs/community.aws.aws_region_info_module.rst | 25 +- ...ommunity.aws.aws_s3_bucket_info_module.rst | 25 +- docs/community.aws.aws_s3_cors_module.rst | 23 +- docs/community.aws.aws_secret_module.rst | 25 +- .../community.aws.aws_ses_identity_module.rst | 25 +- ...ity.aws.aws_ses_identity_policy_module.rst | 25 +- .../community.aws.aws_ses_rule_set_module.rst | 25 +- docs/community.aws.aws_sgw_info_module.rst | 24 +- docs/community.aws.aws_ssm_connection.rst | 20 +- ...ity.aws.aws_ssm_parameter_store_module.rst | 25 +- ...nctions_state_machine_execution_module.rst | 23 +- ...ws_step_functions_state_machine_module.rst | 23 +- ...community.aws.aws_waf_condition_module.rst | 23 +- docs/community.aws.aws_waf_info_module.rst | 24 +- docs/community.aws.aws_waf_rule_module.rst | 23 +- docs/community.aws.aws_waf_web_acl_module.rst | 23 +- ...aws.cloudformation_exports_info_module.rst | 24 +- ...ty.aws.cloudformation_stack_set_module.rst | 25 +- ...ity.aws.cloudfront_distribution_module.rst | 98 +- docs/community.aws.cloudfront_info_module.rst | 24 +- ...ity.aws.cloudfront_invalidation_module.rst | 24 +- ...oudfront_origin_access_identity_module.rst | 24 +- docs/community.aws.cloudtrail_module.rst | 25 +- ...munity.aws.cloudwatchevent_rule_module.rst | 24 +- ...s.cloudwatchlogs_log_group_info_module.rst | 25 +- ...tchlogs_log_group_metric_filter_module.rst | 25 +- ...ty.aws.cloudwatchlogs_log_group_module.rst | 26 +- docs/community.aws.data_pipeline_module.rst | 24 +- docs/community.aws.dms_endpoint_module.rst | 23 +- ...ws.dms_replication_subnet_group_module.rst | 23 +- docs/community.aws.dynamodb_table_module.rst | 26 +- docs/community.aws.dynamodb_ttl_module.rst | 28 +- docs/community.aws.ec2_ami_copy_module.rst | 24 +- docs/community.aws.ec2_asg_info_module.rst | 24 +- ...nity.aws.ec2_asg_lifecycle_hook_module.rst | 24 +- docs/community.aws.ec2_asg_module.rst | 25 +- ...y.aws.ec2_customer_gateway_info_module.rst | 24 +- ...munity.aws.ec2_customer_gateway_module.rst | 25 +- docs/community.aws.ec2_eip_info_module.rst | 23 +- docs/community.aws.ec2_eip_module.rst | 23 +- docs/community.aws.ec2_elb_info_module.rst | 35 +- ...mmunity.aws.ec2_launch_template_module.rst | 27 +- docs/community.aws.ec2_lc_find_module.rst | 24 +- docs/community.aws.ec2_lc_info_module.rst | 24 +- docs/community.aws.ec2_lc_module.rst | 24 +- .../community.aws.ec2_metric_alarm_module.rst | 23 +- ...ty.aws.ec2_placement_group_info_module.rst | 23 +- ...mmunity.aws.ec2_placement_group_module.rst | 23 +- ...ommunity.aws.ec2_scaling_policy_module.rst | 23 +- ...community.aws.ec2_snapshot_copy_module.rst | 24 +- ...ty.aws.ec2_transit_gateway_info_module.rst | 25 +- ...mmunity.aws.ec2_transit_gateway_module.rst | 25 +- ...ommunity.aws.ec2_vpc_egress_igw_module.rst | 23 +- ...community.aws.ec2_vpc_nacl_info_module.rst | 24 +- docs/community.aws.ec2_vpc_nacl_module.rst | 26 +- docs/community.aws.ec2_vpc_peer_module.rst | 46 +- ...munity.aws.ec2_vpc_peering_info_module.rst | 24 +- ...ty.aws.ec2_vpc_route_table_info_module.rst | 23 +- ...mmunity.aws.ec2_vpc_route_table_module.rst | 23 +- .../community.aws.ec2_vpc_vgw_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vgw_module.rst | 24 +- .../community.aws.ec2_vpc_vpn_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vpn_module.rst | 25 +- .../community.aws.ec2_win_password_module.rst | 24 +- docs/community.aws.ecs_attribute_module.rst | 25 +- docs/community.aws.ecs_cluster_module.rst | 24 +- docs/community.aws.ecs_ecr_module.rst | 25 +- .../community.aws.ecs_service_info_module.rst | 26 +- docs/community.aws.ecs_service_module.rst | 29 +- docs/community.aws.ecs_tag_module.rst | 25 +- docs/community.aws.ecs_task_module.rst | 27 +- ...ity.aws.ecs_taskdefinition_info_module.rst | 26 +- ...ommunity.aws.ecs_taskdefinition_module.rst | 43 +- docs/community.aws.efs_info_module.rst | 28 +- docs/community.aws.efs_module.rst | 26 +- ...e.rst => community.aws.efs_tag_module.rst} | 229 ++-- .../community.aws.elasticache_info_module.rst | 23 +- docs/community.aws.elasticache_module.rst | 24 +- ...aws.elasticache_parameter_group_module.rst | 25 +- ...munity.aws.elasticache_snapshot_module.rst | 25 +- ...ty.aws.elasticache_subnet_group_module.rst | 155 ++- ...ity.aws.elb_application_lb_info_module.rst | 60 +- ...ommunity.aws.elb_application_lb_module.rst | 43 +- ...mmunity.aws.elb_classic_lb_info_module.rst | 25 +- docs/community.aws.elb_classic_lb_module.rst | 843 -------------- docs/community.aws.elb_instance_module.rst | 37 +- docs/community.aws.elb_network_lb_module.rst | 43 +- ...unity.aws.elb_target_group_info_module.rst | 24 +- .../community.aws.elb_target_group_module.rst | 24 +- docs/community.aws.elb_target_info_module.rst | 25 +- docs/community.aws.elb_target_module.rst | 23 +- docs/community.aws.execute_lambda_module.rst | 24 +- docs/community.aws.iam_cert_module.rst | 24 +- docs/community.aws.iam_group_module.rst | 25 +- ...ommunity.aws.iam_managed_policy_module.rst | 25 +- ...mmunity.aws.iam_mfa_device_info_module.rst | 25 +- docs/community.aws.iam_module.rst | 35 +- ...mmunity.aws.iam_password_policy_module.rst | 25 +- docs/community.aws.iam_policy_info_module.rst | 23 +- docs/community.aws.iam_policy_module.rst | 23 +- docs/community.aws.iam_role_info_module.rst | 24 +- docs/community.aws.iam_role_module.rst | 27 +- ...mmunity.aws.iam_saml_federation_module.rst | 24 +- ...aws.iam_server_certificate_info_module.rst | 25 +- docs/community.aws.iam_user_info_module.rst | 25 +- docs/community.aws.iam_user_module.rst | 25 +- docs/community.aws.kinesis_stream_module.rst | 24 +- docs/community.aws.lambda_alias_module.rst | 24 +- docs/community.aws.lambda_event_module.rst | 24 +- docs/community.aws.lambda_facts_module.rst | 24 +- docs/community.aws.lambda_info_module.rst | 24 +- docs/community.aws.lambda_module.rst | 26 +- docs/community.aws.lambda_policy_module.rst | 24 +- docs/community.aws.lightsail_module.rst | 24 +- ...community.aws.rds_instance_info_module.rst | 25 +- docs/community.aws.rds_instance_module.rst | 25 +- docs/community.aws.rds_module.rst | 38 +- docs/community.aws.rds_param_group_module.rst | 24 +- ...community.aws.rds_snapshot_info_module.rst | 24 +- docs/community.aws.rds_snapshot_module.rst | 24 +- .../community.aws.rds_subnet_group_module.rst | 23 +- ...redshift_cross_region_snapshots_module.rst | 25 +- docs/community.aws.redshift_info_module.rst | 24 +- docs/community.aws.redshift_module.rst | 24 +- ...unity.aws.redshift_subnet_group_module.rst | 26 +- ...munity.aws.route53_health_check_module.rst | 24 +- docs/community.aws.route53_info_module.rst | 23 +- docs/community.aws.route53_module.rst | 25 +- docs/community.aws.route53_zone_module.rst | 24 +- ...nity.aws.s3_bucket_notification_module.rst | 24 +- docs/community.aws.s3_lifecycle_module.rst | 23 +- docs/community.aws.s3_logging_module.rst | 23 +- ...ty.aws.s3_metrics_configuration_module.rst | 23 +- docs/community.aws.s3_sync_module.rst | 31 +- docs/community.aws.s3_website_module.rst | 24 +- docs/community.aws.sns_module.rst | 25 +- docs/community.aws.sns_topic_module.rst | 43 +- docs/community.aws.sqs_queue_module.rst | 26 +- docs/community.aws.sts_assume_role_module.rst | 25 +- ...community.aws.sts_session_token_module.rst | 25 +- ...community.aws.wafv2_ip_set_info_module.rst | 25 +- docs/community.aws.wafv2_ip_set_module.rst | 25 +- ...munity.aws.wafv2_resources_info_module.rst | 25 +- docs/community.aws.wafv2_resources_module.rst | 25 +- ...unity.aws.wafv2_rule_group_info_module.rst | 25 +- .../community.aws.wafv2_rule_group_module.rst | 25 +- ...ommunity.aws.wafv2_web_acl_info_module.rst | 25 +- docs/community.aws.wafv2_web_acl_module.rst | 25 +- galaxy.yml | 4 +- meta/runtime.yml | 11 +- plugins/modules/aws_msk_cluster.py | 1 - plugins/modules/aws_msk_config.py | 3 - plugins/modules/cloudfront_distribution.py | 3 +- plugins/modules/dynamodb_table.py | 4 +- plugins/modules/ec2_eip.py | 5 +- plugins/modules/elasticache_subnet_group.py | 248 ++-- plugins/modules/elb_target_group.py | 28 + ...{iam_cert.py => iam_server_certificate.py} | 37 +- plugins/modules/rds_instance_info.py | 5 + plugins/modules/redshift_subnet_group.py | 281 +++-- plugins/modules/route53.py | 1 + plugins/modules/sns_topic.py | 105 +- requirements.txt | 9 +- test-requirements.txt | 6 + tests/config.yml | 2 + tests/integration/constraints.txt | 8 +- tests/integration/requirements.txt | 11 +- .../targets/aws_msk_cluster/tasks/main.yml | 72 +- .../targets/aws_msk_config/tasks/main.yml | 295 +++-- .../tasks/bucket_ownership_controls.yml | 2 +- .../targets/dynamodb_table/aliases | 1 + .../targets/dynamodb_table/defaults/main.yml | 47 + .../targets/dynamodb_table/meta/main.yml | 2 + .../targets/dynamodb_table/tasks/main.yml | 733 ++++++++++++ .../targets/ec2_eip/tasks/main.yml | 25 + tests/integration/targets/elasticache/aliases | 2 - .../targets/elasticache_subnet_group/aliases | 1 + .../defaults/main.yml | 42 + .../elasticache_subnet_group/meta/main.yml | 3 + .../elasticache_subnet_group/tasks/main.yml | 681 +++++++++++ .../targets/elb_target/tasks/ec2_target.yml | 160 ++- .../targets/iam_server_certificate/aliases | 3 + .../iam_server_certificate/defaults/main.yml | 1 + .../iam_server_certificate/meta/main.yml | 3 + .../iam_server_certificate/tasks/main.yml | 34 + .../targets/redshift_subnet_group/aliases | 1 + .../redshift_subnet_group/defaults/main.yml | 42 + .../redshift_subnet_group/meta/main.yml | 3 + .../redshift_subnet_group/tasks/main.yml | 692 +++++++++++ .../targets/route53/tasks/main.yml | 65 ++ .../setup_botocore_pip/defaults/main.yml | 2 + .../setup_botocore_pip/handlers/main.yml | 2 + .../setup_botocore_pip/tasks/cleanup.yml | 5 + .../targets/setup_botocore_pip/tasks/main.yml | 42 + .../targets/setup_ec2_facts/defaults/main.yml | 3 + .../targets/setup_ec2_facts/tasks/main.yml | 53 + .../setup_sshkey/files/ec2-fingerprint.py | 33 + .../targets/setup_sshkey/tasks/main.yml | 71 ++ .../targets/sns_topic/tasks/main.yml | 6 +- tests/requirements.yml | 4 +- tests/sanity/ignore-2.13.txt | 3 + tests/unit/constraints.txt | 7 + tests/unit/requirements.txt | 7 +- 273 files changed, 7965 insertions(+), 3665 deletions(-) create mode 100644 bindep.txt create mode 100644 changelogs/fragments/0-copy_ignore_txt.yml delete mode 100644 changelogs/fragments/499-elb-module-add-ip_address_type_option.yml delete mode 100644 changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml delete mode 100644 changelogs/fragments/564-route53-retries.yml delete mode 100644 changelogs/fragments/574-ecs_taskdefinition-improvement.yml delete mode 100644 changelogs/fragments/586-elb-renames.yml delete mode 100644 changelogs/fragments/592-sqs_queue-idempotent.yml create mode 100644 changelogs/fragments/595-fix-route53-identifer.yaml delete mode 100644 changelogs/fragments/600-ecs-task-defination-env-file-validations.yml delete mode 100644 changelogs/fragments/614-ec2_vpc_peer-tagging.yml delete mode 100644 changelogs/fragments/616-ec2_vpc_route_table-tagging.yml delete mode 100644 changelogs/fragments/629-imports-cleanup.yml delete mode 100644 changelogs/fragments/648-kms_info.yml delete mode 100644 changelogs/fragments/659-checkmode.yml delete mode 100644 changelogs/fragments/663-deprecate-rds.yml delete mode 100644 changelogs/fragments/664-deprecate-iam.yml create mode 100644 changelogs/fragments/670-elb_target_group-new_attriibutes.yml delete mode 100644 changelogs/fragments/675-boto3-minimums.yml delete mode 100644 changelogs/fragments/681-aws_secret-deletion-idempotency.yml delete mode 100644 changelogs/fragments/682-aws_s3_bucket_info-botocore.yml delete mode 100644 changelogs/fragments/686-pylint.yml delete mode 100644 changelogs/fragments/688-pylint.yml delete mode 100644 changelogs/fragments/692-s3_sync-individual-file-path.yml delete mode 100644 changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml create mode 100644 changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml create mode 100644 changelogs/fragments/724-redshift_subnet_group-boto3.yml create mode 100644 changelogs/fragments/728-iam_cert.yml create mode 100644 changelogs/fragments/731-ec2_eip-not_in_vpc.yml create mode 100644 changelogs/fragments/735-iam_server_certificate-file-names.yml create mode 100644 changelogs/fragments/739-sns_topic-delivery_policy-shape.yml delete mode 100644 changelogs/fragments/deprecate_ec2_inv_script.yml delete mode 100644 changelogs/fragments/migrate_ec2_instance.yml delete mode 100644 changelogs/fragments/migrate_ec2_vpc_endpoint.yml delete mode 100644 changelogs/fragments/migrate_ec2_vpc_igw.yml delete mode 100644 changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml delete mode 100644 changelogs/fragments/rename-connection-retries.yml delete mode 100644 changelogs/fragments/sns_topic_type.yml create mode 100644 docs/community.aws.aws_msk_cluster_module.rst create mode 100644 docs/community.aws.aws_msk_config_module.rst rename docs/{community.aws.ec2_elb_module.rst => community.aws.efs_tag_module.rst} (72%) delete mode 100644 docs/community.aws.elb_classic_lb_module.rst rename plugins/modules/{iam_cert.py => iam_server_certificate.py} (88%) create mode 100644 tests/config.yml create mode 100644 tests/integration/targets/dynamodb_table/aliases create mode 100644 tests/integration/targets/dynamodb_table/defaults/main.yml create mode 100644 tests/integration/targets/dynamodb_table/meta/main.yml create mode 100644 tests/integration/targets/dynamodb_table/tasks/main.yml create mode 100644 tests/integration/targets/elasticache_subnet_group/aliases create mode 100644 tests/integration/targets/elasticache_subnet_group/defaults/main.yml create mode 100644 tests/integration/targets/elasticache_subnet_group/meta/main.yml create mode 100644 tests/integration/targets/elasticache_subnet_group/tasks/main.yml create mode 100644 tests/integration/targets/iam_server_certificate/aliases create mode 100644 tests/integration/targets/iam_server_certificate/defaults/main.yml create mode 100644 tests/integration/targets/iam_server_certificate/meta/main.yml create mode 100644 tests/integration/targets/iam_server_certificate/tasks/main.yml create mode 100644 tests/integration/targets/redshift_subnet_group/aliases create mode 100644 tests/integration/targets/redshift_subnet_group/defaults/main.yml create mode 100644 tests/integration/targets/redshift_subnet_group/meta/main.yml create mode 100644 tests/integration/targets/redshift_subnet_group/tasks/main.yml create mode 100644 tests/integration/targets/setup_botocore_pip/defaults/main.yml create mode 100644 tests/integration/targets/setup_botocore_pip/handlers/main.yml create mode 100644 tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml create mode 100644 tests/integration/targets/setup_botocore_pip/tasks/main.yml create mode 100644 tests/integration/targets/setup_ec2_facts/defaults/main.yml create mode 100644 tests/integration/targets/setup_ec2_facts/tasks/main.yml create mode 100644 tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py create mode 100644 tests/integration/targets/setup_sshkey/tasks/main.yml create mode 100644 tests/sanity/ignore-2.13.txt create mode 100644 tests/unit/constraints.txt diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3a5c31399fd..3c330f1d0f6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,126 @@ community.aws Release Notes .. contents:: Topics +v2.0.0 +====== + +Major Changes +------------- + +- community.aws collection - The community.aws collection has dropped support for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). + +Minor Changes +------------- + +- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) +- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). +- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). +- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). +- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). +- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). +- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). +- elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). +- elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). +- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). +- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). +- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). +- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). +- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). +- sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). +- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) +- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + +Breaking Changes / Porting Guide +-------------------------------- + +- ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. +- ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. +- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint``. +- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. +- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw``. +- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. +- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. +- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. +- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. +- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. +- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). + +Deprecated Features +------------------- + +- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. +- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). +- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). +- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. + +Bugfixes +-------- + +- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). +- aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries +- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). +- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). +- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). +- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). +- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). +- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). +- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). +- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). +- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). + +New Modules +----------- + +- aws_msk_cluster - Manage Amazon MSK clusters. +- aws_msk_config - Manage Amazon MSK cluster configurations. +- efs_tag - create and remove tags on Amazon EFS resources + v1.5.0 ====== diff --git a/README.md b/README.md index 6c2e3fafdc9..a04e88b9e9d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ As the AWS SDK for Python (Boto3 and Botocore) has [ceased supporting Python 2.7 Starting with the 2.0.0 releases of amazon.aws and community.aws, it is generally the collection's policy to support the versions of `botocore` and `boto3` that were released 12 months prior to the most recent major collection release, following semantic versioning (for example, 2.0.0, 3.0.0). -Version 2.0.0 of this collection supports `boto3 >= 1.13.0` and `botocore >= 1.16.0` +Version 2.0.0 of this collection supports `boto3 >= 1.15.0` and `botocore >= 1.18.0` ## Included content @@ -59,6 +59,8 @@ Name | Description [community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets [community.aws.aws_kms](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_module.rst)|Perform various KMS management tasks. [community.aws.aws_kms_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_info_module.rst)|Gather information about AWS KMS keys +[community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters. +[community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations. [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions. [community.aws.aws_s3_bucket_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_bucket_info_module.rst)|lists S3 buckets in AWS [community.aws.aws_s3_cors](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_cors_module.rst)|Manage CORS for S3 buckets in AWS @@ -98,10 +100,7 @@ Name | Description [community.aws.ec2_customer_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_customer_gateway_info_module.rst)|Gather information about customer gateways in AWS [community.aws.ec2_eip](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_module.rst)|manages EC2 elastic IP (EIP) addresses. [community.aws.ec2_eip_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_info_module.rst)|List EC2 EIP details -[community.aws.ec2_elb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.ec2_elb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS -[community.aws.ec2_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_module.rst)|Create & manage EC2 instances -[community.aws.ec2_instance_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_info_module.rst)|Gather information about ec2 instances in AWS [community.aws.ec2_launch_template](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_launch_template_module.rst)|Manage EC2 launch templates [community.aws.ec2_lc](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_module.rst)|Create or delete AWS Autoscaling Launch Configurations [community.aws.ec2_lc_find](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_find_module.rst)|Find AWS Autoscaling Launch Configurations @@ -114,15 +113,8 @@ Name | Description [community.aws.ec2_transit_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_module.rst)|Create and delete AWS Transit Gateways [community.aws.ec2_transit_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_info_module.rst)|Gather information about ec2 transit gateways in AWS [community.aws.ec2_vpc_egress_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_egress_igw_module.rst)|Manage an AWS VPC Egress Only Internet gateway -[community.aws.ec2_vpc_endpoint](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_module.rst)|Create and delete AWS VPC Endpoints. -[community.aws.ec2_vpc_endpoint_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_info_module.rst)|Retrieves AWS VPC endpoints details using AWS methods. -[community.aws.ec2_vpc_endpoint_service_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_service_info_module.rst)|retrieves AWS VPC endpoint service details -[community.aws.ec2_vpc_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_module.rst)|Manage an AWS VPC Internet gateway -[community.aws.ec2_vpc_igw_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_info_module.rst)|Gather information about internet gateways in AWS [community.aws.ec2_vpc_nacl](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_module.rst)|create and delete Network ACLs. [community.aws.ec2_vpc_nacl_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_info_module.rst)|Gather information about Network ACLs in an AWS VPC -[community.aws.ec2_vpc_nat_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_module.rst)|Manage AWS VPC NAT Gateways. -[community.aws.ec2_vpc_nat_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst)|Retrieves AWS VPC Managed Nat Gateway details using AWS methods. [community.aws.ec2_vpc_peer](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peer_module.rst)|create, delete, accept, and reject VPC peering connections between two VPCs. [community.aws.ec2_vpc_peering_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peering_info_module.rst)|Retrieves AWS VPC Peering details using AWS methods. [community.aws.ec2_vpc_route_table](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_route_table_module.rst)|Manage route tables for AWS virtual private clouds @@ -143,6 +135,7 @@ Name | Description [community.aws.ecs_taskdefinition_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_taskdefinition_info_module.rst)|Describe a task definition in ECS [community.aws.efs](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_module.rst)|create and maintain EFS file systems [community.aws.efs_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_info_module.rst)|Get information about Amazon EFS file systems +[community.aws.efs_tag](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_tag_module.rst)|create and remove tags on Amazon EFS resources [community.aws.elasticache](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_module.rst)|Manage cache clusters in Amazon ElastiCache [community.aws.elasticache_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_info_module.rst)|Retrieve information for AWS ElastiCache clusters [community.aws.elasticache_parameter_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_parameter_group_module.rst)|Manage cache parameter groups in Amazon ElastiCache. @@ -150,7 +143,6 @@ Name | Description [community.aws.elasticache_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_subnet_group_module.rst)|manage ElastiCache subnet groups [community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application Load Balancer [community.aws.elb_application_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_info_module.rst)|Gather information about application ELBs in AWS -[community.aws.elb_classic_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_module.rst)|Creates or destroys Amazon ELB. [community.aws.elb_classic_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS [community.aws.elb_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_instance_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.elb_network_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_network_lb_module.rst)|Manage a Network Load Balancer diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 00000000000..a336e642f5f --- /dev/null +++ b/bindep.txt @@ -0,0 +1,4 @@ +# Needed for generating EC2 format fingerprints +openssl [test platform:rpm] +gcc [test platform:rpm] +python3-devel [test platform:rpm] diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 1dfb7e79f32..ca10bd97e9e 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1125,3 +1125,222 @@ releases: name: wafv2_web_acl_info namespace: '' release_date: '2021-04-27' + 2.0.0: + changes: + breaking_changes: + - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should + be updated to use ``amazon.aws.ec2_instance``. + - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should + be updated to use ``amazon.aws.ec2_instance_info``. + - ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint``. + - ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. + - ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. + - ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. + - ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should + be updated to use ``amazon.aws.ec2_vpc_igw``. + - ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_igw_info``. + - ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_igw_info``. + - ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. + - ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. + - ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. + - kms_info - key details are now returned in the ``kms_keys`` attribute rather + than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). + bugfixes: + - aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). + - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict + with task retries + - ec2_vpc_peer - automatically retry when attempting to tag freshly created + peering connections (https://github.com/ansible-collections/community.aws/pull/614). + - ec2_vpc_route_table - automatically retry when attempting to modify freshly + created route tables (https://github.com/ansible-collections/community.aws/pull/616). + - ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). + - ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). + - ecs_taskdefinition - fix typo in ecs task defination for env file validations + (https://github.com/ansible-collections/community.aws/pull/600). + - iam_role - Modified iam_role internal code to replace update_role_description + with update_role (https://github.com/ansible-collections/community.aws/pull/697). + - route53 - fix typo in waiter configuration that prevented management of the + delays (https://github.com/ansible-collections/community.aws/pull/564). + - s3_sync - fix handling individual file path to upload a individual file to + s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). + - sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). + deprecated_features: + - ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` + module which functions identically. The original ``ec2_elb`` name is now deprecated + and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). + - ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated + in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` + module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). + - elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected + to the ``amazon.aws.ec2_elb_lb`` module which functions identically. + - iam - the boto based ``iam`` module has been deprecated in favour of the boto3 + based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module + will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). + - rds - the boto based ``rds`` module has been deprecated in favour of the boto3 + based ``rds_instance`` module. The ``rds`` module will be removed in release + 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). + - script_inventory_ec2 - The ec2.py inventory script is being moved to a new + repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py + and will be removed from this collection in the 3.0 release. We recommend + migrating from the script to the `amazon.aws.ec2` inventory plugin. + major_changes: + - community.aws collection - The community.aws collection has dropped support + for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). + Most modules will continue to work with older versions of the AWS SDK, however + compatability with older versions of the SDK is not guaranteed and will not + be tested. When using older versions of the SDK a warning will be emitted + by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). + minor_changes: + - aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch + bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) + - aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - cloudformation_stack_set - Tests for compatability with older versions of + the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - dynamodb_table - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_asg - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - ec2_launch_template - Tests for compatability with older versions of the AWS + SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - ec2_transit_gateway - Tests for compatability with older versions of the AWS + SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_transit_gateway_info - Tests for compatability with older versions of + the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). + - ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). + - ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). + - ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). + - ecs_ecr - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ecs_service - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ecs_task - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). + - ecs_taskdefinition - Tests for compatability with older versions of the AWS + SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - efs - Tests for compatability with older versions of the AWS SDKs have been + removed (https://github.com/ansible-collections/community.aws/pull/675). + - efs_info - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). + - elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). + - elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). + - elb_application_lb - added ``ip_address_type`` parameter to support changing + application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). + - elb_application_lb_info - added ``ip_address_type`` in output when gathering + application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). + - elb_instance - make elb_instance idempotent when deregistering instances. Merged + from ec2_elb U(https://github.com/ansible/ansible/pull/31660). + - elb_network_lb - added ``ip_address_type`` parameter to support changing network + load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). + - elb_target_group - Tests for compatability with older versions of the AWS + SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - iam_role - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - kms_info - added a new ``keys_attr`` parameter to continue returning the key + details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). + - lambda - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - rds_instance - Tests for compatability with older versions of the AWS SDKs + have been removed (https://github.com/ansible-collections/community.aws/pull/675). + - rds_instance - convert ``preferred_maintenance_window`` days into lowercase + so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). + - rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). + - route53 - add rate-limiting retries while waiting for changes to propagate + (https://github.com/ansible-collections/community.aws/pull/564). + - route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). + - route53 - update retry ``max_delay`` setting so that it can be set above 60 + seconds (https://github.com/ansible-collections/community.aws/pull/564). + - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either + FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). + - sqs_queue - Tests for compatability with older versions of the AWS SDKs have + been removed (https://github.com/ansible-collections/community.aws/pull/675). + - various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) + - wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + - wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). + fragments: + - 499-elb-module-add-ip_address_type_option.yml + - 516-rds_instance-preferred_maintenance_window.yml + - 564-route53-retries.yml + - 574-ecs_taskdefinition-improvement.yml + - 586-elb-renames.yml + - 592-sqs_queue-idempotent.yml + - 600-ecs-task-defination-env-file-validations.yml + - 614-ec2_vpc_peer-tagging.yml + - 616-ec2_vpc_route_table-tagging.yml + - 629-imports-cleanup.yml + - 648-kms_info.yml + - 659-checkmode.yml + - 663-deprecate-rds.yml + - 664-deprecate-iam.yml + - 675-boto3-minimums.yml + - 675-boto3-minimums.yml + - 681-aws_secret-deletion-idempotency.yml + - 682-aws_s3_bucket_info-botocore.yml + - 686-pylint.yml + - 688-pylint.yml + - 692-s3_sync-individual-file-path.yml + - 697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml + - 723-elasticache_subnet_group-boto3.yml + - deprecate_ec2_inv_script.yml + - migrate_ec2_instance.yml + - migrate_ec2_vpc_endpoint.yml + - migrate_ec2_vpc_igw.yml + - migrate_ec2_vpc_nat_gateway.yml + - rename-connection-retries.yml + - sns_topic_type.yml + modules: + - description: Manage Amazon MSK clusters. + name: aws_msk_cluster + namespace: '' + - description: Manage Amazon MSK cluster configurations. + name: aws_msk_config + namespace: '' + - description: create and remove tags on Amazon EFS resources + name: efs_tag + namespace: '' + release_date: '2021-09-14' diff --git a/changelogs/fragments/0-copy_ignore_txt.yml b/changelogs/fragments/0-copy_ignore_txt.yml new file mode 100644 index 00000000000..ec804d278dd --- /dev/null +++ b/changelogs/fragments/0-copy_ignore_txt.yml @@ -0,0 +1,3 @@ +--- +trivial: + - Copy ignore.txt. diff --git a/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml b/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml deleted file mode 100644 index afc1f939be0..00000000000 --- a/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). diff --git a/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml b/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml deleted file mode 100644 index c986d684cbc..00000000000 --- a/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). diff --git a/changelogs/fragments/564-route53-retries.yml b/changelogs/fragments/564-route53-retries.yml deleted file mode 100644 index 46a99b56be2..00000000000 --- a/changelogs/fragments/564-route53-retries.yml +++ /dev/null @@ -1,6 +0,0 @@ -bugfixes: -- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). -minor_changes: -- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). diff --git a/changelogs/fragments/574-ecs_taskdefinition-improvement.yml b/changelogs/fragments/574-ecs_taskdefinition-improvement.yml deleted file mode 100644 index c8667401464..00000000000 --- a/changelogs/fragments/574-ecs_taskdefinition-improvement.yml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: -- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). -- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). diff --git a/changelogs/fragments/586-elb-renames.yml b/changelogs/fragments/586-elb-renames.yml deleted file mode 100644 index 0b799f0c0f6..00000000000 --- a/changelogs/fragments/586-elb-renames.yml +++ /dev/null @@ -1,8 +0,0 @@ -minor_changes: -- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). -deprecated_features: -- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. - The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. - The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. diff --git a/changelogs/fragments/592-sqs_queue-idempotent.yml b/changelogs/fragments/592-sqs_queue-idempotent.yml deleted file mode 100644 index 94bd5ef2388..00000000000 --- a/changelogs/fragments/592-sqs_queue-idempotent.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). diff --git a/changelogs/fragments/595-fix-route53-identifer.yaml b/changelogs/fragments/595-fix-route53-identifer.yaml new file mode 100644 index 00000000000..11901c1655b --- /dev/null +++ b/changelogs/fragments/595-fix-route53-identifer.yaml @@ -0,0 +1,2 @@ +bugfixes: + - route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). diff --git a/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml b/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml deleted file mode 100644 index e9186e00354..00000000000 --- a/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). diff --git a/changelogs/fragments/614-ec2_vpc_peer-tagging.yml b/changelogs/fragments/614-ec2_vpc_peer-tagging.yml deleted file mode 100644 index 1e76f6b86ab..00000000000 --- a/changelogs/fragments/614-ec2_vpc_peer-tagging.yml +++ /dev/null @@ -1,4 +0,0 @@ -bugfixes: -- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). -minor_changes: -- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). diff --git a/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml b/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml deleted file mode 100644 index 44ff49b8b38..00000000000 --- a/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml +++ /dev/null @@ -1,4 +0,0 @@ -bugfixes: -- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). -minor_changes: -- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). diff --git a/changelogs/fragments/629-imports-cleanup.yml b/changelogs/fragments/629-imports-cleanup.yml deleted file mode 100644 index 211aea45988..00000000000 --- a/changelogs/fragments/629-imports-cleanup.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) diff --git a/changelogs/fragments/648-kms_info.yml b/changelogs/fragments/648-kms_info.yml deleted file mode 100644 index 8589c07cf4c..00000000000 --- a/changelogs/fragments/648-kms_info.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). -breaking_changes: -- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). diff --git a/changelogs/fragments/659-checkmode.yml b/changelogs/fragments/659-checkmode.yml deleted file mode 100644 index dc9c541bb21..00000000000 --- a/changelogs/fragments/659-checkmode.yml +++ /dev/null @@ -1,10 +0,0 @@ -minor_changes: -- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). diff --git a/changelogs/fragments/663-deprecate-rds.yml b/changelogs/fragments/663-deprecate-rds.yml deleted file mode 100644 index 787a090903d..00000000000 --- a/changelogs/fragments/663-deprecate-rds.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. - The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). diff --git a/changelogs/fragments/664-deprecate-iam.yml b/changelogs/fragments/664-deprecate-iam.yml deleted file mode 100644 index b3dcc3665c2..00000000000 --- a/changelogs/fragments/664-deprecate-iam.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. - The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). diff --git a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml b/changelogs/fragments/670-elb_target_group-new_attriibutes.yml new file mode 100644 index 00000000000..bff32308d56 --- /dev/null +++ b/changelogs/fragments/670-elb_target_group-new_attriibutes.yml @@ -0,0 +1,3 @@ +minor_changes: + - elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). + - elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). \ No newline at end of file diff --git a/changelogs/fragments/675-boto3-minimums.yml b/changelogs/fragments/675-boto3-minimums.yml deleted file mode 100644 index 359636714d4..00000000000 --- a/changelogs/fragments/675-boto3-minimums.yml +++ /dev/null @@ -1,26 +0,0 @@ -major_changes: -- community.aws collection - The community.aws collection has dropped support for ``botocore<1.16.0`` and ``boto3<1.13.0`` (https://github.com/ansible-collections/community.aws/pull/675). - Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. - When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). -minor_changes: -- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). diff --git a/changelogs/fragments/681-aws_secret-deletion-idempotency.yml b/changelogs/fragments/681-aws_secret-deletion-idempotency.yml deleted file mode 100644 index ac7910ef23b..00000000000 --- a/changelogs/fragments/681-aws_secret-deletion-idempotency.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). diff --git a/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml b/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml deleted file mode 100644 index 1577bd8d9a4..00000000000 --- a/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) diff --git a/changelogs/fragments/686-pylint.yml b/changelogs/fragments/686-pylint.yml deleted file mode 100644 index 43b91aaef88..00000000000 --- a/changelogs/fragments/686-pylint.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). -- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). -- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). diff --git a/changelogs/fragments/688-pylint.yml b/changelogs/fragments/688-pylint.yml deleted file mode 100644 index 6008db9cf0f..00000000000 --- a/changelogs/fragments/688-pylint.yml +++ /dev/null @@ -1,10 +0,0 @@ -minor_changes: -- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). diff --git a/changelogs/fragments/692-s3_sync-individual-file-path.yml b/changelogs/fragments/692-s3_sync-individual-file-path.yml deleted file mode 100644 index 77b7ac80522..00000000000 --- a/changelogs/fragments/692-s3_sync-individual-file-path.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). diff --git a/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml b/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml deleted file mode 100644 index a31b43451d9..00000000000 --- a/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). diff --git a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml b/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml new file mode 100644 index 00000000000..82f82192f72 --- /dev/null +++ b/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml @@ -0,0 +1,2 @@ +minor_changes: +- cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer connections (https://github.com/ansible-collections/community.aws/pull/707). diff --git a/changelogs/fragments/724-redshift_subnet_group-boto3.yml b/changelogs/fragments/724-redshift_subnet_group-boto3.yml new file mode 100644 index 00000000000..d760eb4c2b8 --- /dev/null +++ b/changelogs/fragments/724-redshift_subnet_group-boto3.yml @@ -0,0 +1,7 @@ +minor_changes: +- redshift_subnet_group - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - the ``group_description`` option has been renamed to ``description`` and is now optional. + The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` and is now only required when creating a new group. + The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). diff --git a/changelogs/fragments/728-iam_cert.yml b/changelogs/fragments/728-iam_cert.yml new file mode 100644 index 00000000000..9fbb3d813cb --- /dev/null +++ b/changelogs/fragments/728-iam_cert.yml @@ -0,0 +1,3 @@ +deprecated_features: +- iam_cert - the iam_cert module has been renamed to iam_server_certificate for consistency with the companion iam_server_certificate_info module. + The usage of the module has not changed. The iam_cert alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). diff --git a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml b/changelogs/fragments/731-ec2_eip-not_in_vpc.yml new file mode 100644 index 00000000000..4020bffd273 --- /dev/null +++ b/changelogs/fragments/731-ec2_eip-not_in_vpc.yml @@ -0,0 +1,2 @@ +bugfixes: +- ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). diff --git a/changelogs/fragments/735-iam_server_certificate-file-names.yml b/changelogs/fragments/735-iam_server_certificate-file-names.yml new file mode 100644 index 00000000000..58720919f7f --- /dev/null +++ b/changelogs/fragments/735-iam_server_certificate-file-names.yml @@ -0,0 +1,3 @@ +deprecated_features: +- iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` and ``key`` parameters has been deprecated. + We recommend using a lookup plugin to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). diff --git a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml b/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml new file mode 100644 index 00000000000..39f60733c2a --- /dev/null +++ b/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml @@ -0,0 +1,2 @@ +bugfixes: +- sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). diff --git a/changelogs/fragments/deprecate_ec2_inv_script.yml b/changelogs/fragments/deprecate_ec2_inv_script.yml deleted file mode 100644 index b0cc461ee58..00000000000 --- a/changelogs/fragments/deprecate_ec2_inv_script.yml +++ /dev/null @@ -1,2 +0,0 @@ -deprecated_features: -- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. diff --git a/changelogs/fragments/migrate_ec2_instance.yml b/changelogs/fragments/migrate_ec2_instance.yml deleted file mode 100644 index fb7c0fadfe7..00000000000 --- a/changelogs/fragments/migrate_ec2_instance.yml +++ /dev/null @@ -1,3 +0,0 @@ -breaking_changes: - - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. - - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_endpoint.yml b/changelogs/fragments/migrate_ec2_vpc_endpoint.yml deleted file mode 100644 index 9b10b55a905..00000000000 --- a/changelogs/fragments/migrate_ec2_vpc_endpoint.yml +++ /dev/null @@ -1,13 +0,0 @@ -breaking_changes: -- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should be updated - to use ``amazon.aws.ec2_vpc_endpoint``. -- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_igw.yml b/changelogs/fragments/migrate_ec2_vpc_igw.yml deleted file mode 100644 index 6ab3da37409..00000000000 --- a/changelogs/fragments/migrate_ec2_vpc_igw.yml +++ /dev/null @@ -1,10 +0,0 @@ -breaking_changes: -- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should be updated - to use ``amazon.aws.ec2_vpc_igw_info``. -- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should be updated - to use ``amazon.aws.ec2_vpc_igw``. -- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should be updated - to use ``amazon.aws.ec2_vpc_igw_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml b/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml deleted file mode 100644 index 678e30e87cd..00000000000 --- a/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml +++ /dev/null @@ -1,10 +0,0 @@ -breaking_changes: -- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. -- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should be updated - to use ``amazon.aws.ec2_vpc_nat_gateway``. -- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. diff --git a/changelogs/fragments/rename-connection-retries.yml b/changelogs/fragments/rename-connection-retries.yml deleted file mode 100644 index 32cc97d3b9b..00000000000 --- a/changelogs/fragments/rename-connection-retries.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries diff --git a/changelogs/fragments/sns_topic_type.yml b/changelogs/fragments/sns_topic_type.yml deleted file mode 100644 index 3c57bb3be36..00000000000 --- a/changelogs/fragments/sns_topic_type.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.aws_acm_info_module.rst index 45d16ff9e5e..c604a405734 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.aws_acm_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -178,7 +178,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,7 +194,6 @@ 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
@@ -228,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -290,7 +289,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -302,8 +301,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_acm_module.rst b/docs/community.aws.aws_acm_module.rst index 29c2d490025..57dbd56c4ba 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.aws_acm_module.rst @@ -41,9 +41,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -285,7 +285,6 @@ 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
@@ -319,7 +318,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -361,7 +360,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -373,8 +372,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index f1505078c9a..4f774d36cef 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -221,7 +221,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,7 +259,6 @@ 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
@@ -293,7 +292,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -450,7 +449,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -464,8 +463,9 @@ Notes - A future version of this module will probably use tags or another ID so that an API can be created 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_application_scaling_policy_module.rst b/docs/community.aws.aws_application_scaling_policy_module.rst index 8afeaa0e24a..4606b53e9ae 100644 --- a/docs/community.aws.aws_application_scaling_policy_module.rst +++ b/docs/community.aws.aws_application_scaling_policy_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -246,7 +244,6 @@ 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
@@ -322,7 +319,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -520,7 +517,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -533,8 +530,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_batch_compute_environment_module.rst b/docs/community.aws.aws_batch_compute_environment_module.rst index 01271a753d9..d8d542942be 100644 --- a/docs/community.aws.aws_batch_compute_environment_module.rst +++ b/docs/community.aws.aws_batch_compute_environment_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -247,7 +247,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -343,7 +343,6 @@ 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
@@ -394,7 +393,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -518,7 +517,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -530,8 +529,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_batch_job_definition_module.rst b/docs/community.aws.aws_batch_job_definition_module.rst index 4b821215793..93b37e4b1bc 100644 --- a/docs/community.aws.aws_batch_job_definition_module.rst +++ b/docs/community.aws.aws_batch_job_definition_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -413,7 +413,6 @@ 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
@@ -462,7 +461,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -599,7 +598,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -676,8 +675,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_batch_job_queue_module.rst b/docs/community.aws.aws_batch_job_queue_module.rst index 8fffc6d6d0d..a385c7624a5 100644 --- a/docs/community.aws.aws_batch_job_queue_module.rst +++ b/docs/community.aws.aws_batch_job_queue_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -194,7 +194,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -261,7 +261,6 @@ 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
@@ -295,7 +294,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -336,7 +335,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -348,8 +347,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_codebuild_module.rst b/docs/community.aws.aws_codebuild_module.rst index 225a721095f..2d84d524e90 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -171,7 +170,7 @@ Parameters -
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.
+
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
@@ -190,7 +189,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -223,7 +222,7 @@ Parameters -
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.
+
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
@@ -325,7 +324,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -473,7 +472,6 @@ 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
@@ -507,7 +505,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -730,7 +728,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -758,8 +756,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_codecommit_module.rst b/docs/community.aws.aws_codecommit_module.rst index 37f2d3bfe65..9d30ec448f2 100644 --- a/docs/community.aws.aws_codecommit_module.rst +++ b/docs/community.aws.aws_codecommit_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,7 +191,6 @@ 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
@@ -226,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +266,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -280,8 +278,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_codepipeline_module.rst b/docs/community.aws.aws_codepipeline_module.rst index 7dc4353b821..b6b2cd3c410 100644 --- a/docs/community.aws.aws_codepipeline_module.rst +++ b/docs/community.aws.aws_codepipeline_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -103,7 +102,7 @@ Parameters -
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.
+
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
@@ -122,7 +121,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -155,7 +154,7 @@ Parameters -
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.
+
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
@@ -192,7 +191,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -224,7 +223,6 @@ 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
@@ -274,7 +272,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -368,7 +366,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -396,8 +394,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_config_aggregation_authorization_module.rst b/docs/community.aws.aws_config_aggregation_authorization_module.rst index 6fccefcc774..2ce46985937 100644 --- a/docs/community.aws.aws_config_aggregation_authorization_module.rst +++ b/docs/community.aws.aws_config_aggregation_authorization_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -86,7 +85,7 @@ Parameters -
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.
+
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
@@ -105,7 +104,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -138,7 +137,7 @@ Parameters -
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.
+
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
@@ -175,7 +174,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,7 +190,6 @@ 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
@@ -225,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -266,7 +264,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -278,8 +276,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_config_aggregator_module.rst b/docs/community.aws.aws_config_aggregator_module.rst index 174310c5eab..4dae621e755 100644 --- a/docs/community.aws.aws_config_aggregator_module.rst +++ b/docs/community.aws.aws_config_aggregator_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -126,7 +125,7 @@ Parameters -
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.
+
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
@@ -145,7 +144,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -178,7 +177,7 @@ Parameters -
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.
+
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
@@ -215,7 +214,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -317,7 +316,6 @@ 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
@@ -351,7 +349,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -392,7 +390,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -404,8 +402,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_config_delivery_channel_module.rst b/docs/community.aws.aws_config_delivery_channel_module.rst index be94d2f101a..e2940cf6c41 100644 --- a/docs/community.aws.aws_config_delivery_channel_module.rst +++ b/docs/community.aws.aws_config_delivery_channel_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -165,7 +164,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -197,7 +196,6 @@ 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
@@ -262,7 +260,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -318,7 +316,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -330,8 +328,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_config_recorder_module.rst b/docs/community.aws.aws_config_recorder_module.rst index 74132eb51ad..439de0efbee 100644 --- a/docs/community.aws.aws_config_recorder_module.rst +++ b/docs/community.aws.aws_config_recorder_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -296,7 +294,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -337,7 +335,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -349,8 +347,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_config_rule_module.rst b/docs/community.aws.aws_config_rule_module.rst index d33a4f33334..87e98cd929d 100644 --- a/docs/community.aws.aws_config_rule_module.rst +++ b/docs/community.aws.aws_config_rule_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -227,7 +226,6 @@ 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
@@ -341,7 +339,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -451,7 +449,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -463,8 +461,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 b105b278bbf..66a9fa6acb4 100644 --- a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,7 +191,6 @@ 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
@@ -226,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -248,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -260,8 +258,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_direct_connect_connection_module.rst b/docs/community.aws.aws_direct_connect_connection_module.rst index 10bf85bb695..cff65666871 100644 --- a/docs/community.aws.aws_direct_connect_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_connection_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -180,7 +179,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -264,7 +263,6 @@ 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
@@ -298,7 +296,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -340,7 +338,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -352,8 +350,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_direct_connect_gateway_module.rst b/docs/community.aws.aws_direct_connect_gateway_module.rst index 6e4a37bd3ae..d8bcfb3fbb4 100644 --- a/docs/community.aws.aws_direct_connect_gateway_module.rst +++ b/docs/community.aws.aws_direct_connect_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -72,7 +72,7 @@ Parameters -
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.
+
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
@@ -91,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +124,7 @@ Parameters -
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.
+
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
@@ -177,7 +177,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -208,7 +208,6 @@ 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
@@ -242,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -284,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -327,8 +326,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 0aafe21240d..47a4b3f1a24 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 @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -192,7 +191,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -302,7 +301,6 @@ 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
@@ -336,7 +334,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -378,7 +376,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -427,8 +425,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 c959826cbce..cac6b60f287 100644 --- a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst +++ b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -99,7 +98,7 @@ Parameters -
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.
+
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
@@ -118,7 +117,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -151,7 +150,7 @@ Parameters -
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.
+
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
@@ -251,7 +250,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -299,7 +298,6 @@ 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
@@ -352,7 +350,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -394,7 +392,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -453,8 +451,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_eks_cluster_module.rst b/docs/community.aws.aws_eks_cluster_module.rst index 6a4e1be3b1c..3bf9973bcdb 100644 --- a/docs/community.aws.aws_eks_cluster_module.rst +++ b/docs/community.aws.aws_eks_cluster_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -240,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -297,7 +295,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -359,8 +357,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_elasticbeanstalk_app_module.rst b/docs/community.aws.aws_elasticbeanstalk_app_module.rst index 5ce6e64dd8d..3ad0c9fa24a 100644 --- a/docs/community.aws.aws_elasticbeanstalk_app_module.rst +++ b/docs/community.aws.aws_elasticbeanstalk_app_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -68,7 +69,7 @@ Parameters -
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.
+
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
@@ -87,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +121,7 @@ Parameters -
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.
+
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
@@ -172,7 +173,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -188,7 +189,6 @@ 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
@@ -222,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -294,8 +294,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_glue_connection_module.rst b/docs/community.aws.aws_glue_connection_module.rst index 2202ff9e781..04afb555c95 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.aws_glue_connection_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -228,7 +228,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -276,7 +276,6 @@ 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
@@ -327,7 +326,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -385,7 +384,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -397,8 +396,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_glue_job_module.rst b/docs/community.aws.aws_glue_job_module.rst index ccbb2bd55f5..00f0e68946c 100644 --- a/docs/community.aws.aws_glue_job_module.rst +++ b/docs/community.aws.aws_glue_job_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -235,7 +235,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,7 +329,6 @@ 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
@@ -379,7 +378,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -436,7 +435,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -469,8 +468,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_inspector_target_module.rst b/docs/community.aws.aws_inspector_target_module.rst index 19d4cda8e15..0a58c6f0f79 100644 --- a/docs/community.aws.aws_inspector_target_module.rst +++ b/docs/community.aws.aws_inspector_target_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -209,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -266,7 +264,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -278,8 +276,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_kms_info_module.rst b/docs/community.aws.aws_kms_info_module.rst index d13db70e882..3753a1966d6 100644 --- a/docs/community.aws.aws_kms_info_module.rst +++ b/docs/community.aws.aws_kms_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -160,7 +161,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -198,6 +199,28 @@ Parameters

aliases: key_arn
+ + +
+ keys_attr + +
+ boolean +
+
added in 2.0.0
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Whether to return the results in the keys attribute as well as the kms_keys attribute.
+
Returning the keys attribute conflicts with the builtin keys() method on dictionaries and as such has been deprecated.
+
After version 3.0.0 this parameter will do nothing, and after version 4.0.0 this parameter will be removed.
+ +
@@ -229,7 +252,6 @@ 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
@@ -263,7 +285,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -285,7 +307,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -297,8 +319,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -339,7 +362,7 @@ Common return values are documented `here
- keys + kms_keys
complex diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index 210d4fcdee7..d51bc1bb2d5 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -68,7 +69,7 @@ Parameters -
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.
+
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
@@ -87,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +121,7 @@ Parameters -
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.
+
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
@@ -172,7 +173,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -481,7 +482,6 @@ 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
@@ -553,7 +553,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -609,7 +609,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -621,8 +621,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_msk_cluster_module.rst b/docs/community.aws.aws_msk_cluster_module.rst new file mode 100644 index 00000000000..b585d1861dc --- /dev/null +++ b/docs/community.aws.aws_msk_cluster_module.rst @@ -0,0 +1,1031 @@ +.. _community.aws.aws_msk_cluster_module: + + +***************************** +community.aws.aws_msk_cluster +***************************** + +**Manage Amazon MSK clusters.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ authentication + +
+ dictionary +
+ 		+ +
Includes all client authentication related information.
+
Effective only for new cluster and can not be updated.
+
+
+ sasl_scram + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
SASL/SCRAM authentication is enabled or not.
+
+
+ tls_ca_arn + +
+ list + / elements=string +
+ 		+ +
List of ACM Certificate Authority ARNs.
+
+
+ aws_access_key + +
+ string +
+ 		+ +
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_ca_bundle + +
+ path +
+ 		+ +
The location of a CA Bundle to use when validating SSL certificates.
+
Not used by boto 2 based modules.
+
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+
+
+ aws_config + +
+ dictionary +
+ 		+ +
A dictionary to modify the botocore configuration.
+ +
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+
+
+ aws_secret_key + +
+ string +
+ 		+ +
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
+
+
+ configuration_arn + +
+ string +
+ 		+ +
ARN of the configuration to use.
+
This parameter is required when state=present.
+
+
+ configuration_revision + +
+ integer +
+ 		+ +
The revision of the configuration to use.
+
This parameter is required when state=present.
+
+
+ debug_botocore_endpoint_logs + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+
+
+ ebs_volume_size + +
+ integer +
+ 		+ Default:
100
+ 		+
The size in GiB of the EBS volume for the data drive on each broker node.
+
+
+ ec2_url + +
+ string +
+ 		+ +
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
+
+
+ encryption + +
+ dictionary +
+ 		+ +
Includes all encryption-related information.
+
Effective only for new cluster and can not be updated.
+
+
+ in_transit + +
+ dictionary +
+ 		+ +
The details for encryption in transit.
+
+
+ client_broker + +
+ string +
+ 		+
    Choices: +
  • TLS ←
    • +
  • TLS_PLAINTEXT
    • +
  • PLAINTEXT
    • +
+ 		+
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only.
+
+
+ in_cluster + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
+
+
+ kms_key_id + +
+ string +
+ 		+ Default:
null
+ 		+
The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
+
+
+ enhanced_monitoring + +
+ string +
+ 		+
    Choices: +
  • DEFAULT ←
    • +
  • PER_BROKER
    • +
  • PER_TOPIC_PER_BROKER
    • +
  • PER_TOPIC_PER_PARTITION
    • +
+ 		+
Specifies the level of monitoring for the MSK cluster.
+
+
+ instance_type + +
+ string +
+ 		+
    Choices: +
  • kafka.t3.small ←
    • +
  • kafka.m5.large
    • +
  • kafka.m5.xlarge
    • +
  • kafka.m5.2xlarge
    • +
  • kafka.m5.4xlarge
    • +
+ 		+
The type of Amazon EC2 instances to use for Kafka brokers.
+
Update operation requires botocore version >= 1.19.58.
+
+
+ logging + +
+ dictionary +
+ 		+ +
Logging configuration.
+
+
+ cloudwatch + +
+ dictionary +
+ 		+ +
Details of the CloudWatch Logs destination for broker logs.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
+
+
+ log_group + +
+ string +
+ 		+ +
The CloudWatch log group that is the destination for broker logs.
+
+
+ firehose + +
+ dictionary +
+ 		+ +
Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
+
+
+ delivery_stream + +
+ string +
+ 		+ +
The Kinesis Data Firehose delivery stream that is the destination for broker logs.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.
+
+
+ s3 + +
+ dictionary +
+ 		+ +
Details of the Amazon S3 destination for broker logs.
+
+
+ bucket + +
+ string +
+ 		+ +
The name of the S3 bucket that is the destination for broker logs.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Specifies whether broker logs get sent to the specified Amazon S3 destination.
+
+
+ prefix + +
+ string +
+ 		+ +
The S3 prefix that is the destination for broker logs.
+
+
+ name + +
+ string + / required +
+ 		+ +
The name of the cluster.
+
+
+ nodes + +
+ integer +
+ 		+ Default:
3
+ 		+
The number of broker nodes in the cluster. Should be greater or equal to two.
+
+
+ open_monitoring + +
+ dictionary +
+ 		+ +
The settings for open monitoring.
+
+
+ jmx_exporter + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Indicates whether you want to enable or disable the JMX Exporter.
+
+
+ node_exporter + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Indicates whether you want to enable or disable the Node Exporter.
+
+
+ profile + +
+ string +
+ 		+ +
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
+
+
+ purge_tags + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Remove tags not listed in tags when tags is specified.
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ security_groups + +
+ list + / elements=string +
+ 		+ +
The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
+
+
+ security_token + +
+ 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
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Create (present) or delete (absent) cluster.
+
+
+ subnets + +
+ list + / elements=string +
+ 		+ +
The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.
+
Client subnets can't be in Availability Zone us-east-1e.
+
This parameter is required when state=present.
+
+
+ tags + +
+ dictionary +
+ 		+ +
Tag dictionary to apply to the cluster.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+
+ version + +
+ string +
+ 		+ +
The version of Apache Kafka.
+
This version should exist in given configuration.
+
This parameter is required when state=present.
+
Update operation requires botocore version >= 1.16.19.
+
+
+ wait + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Whether to wait for the cluster to be available or deleted.
+
+
+ wait_timeout + +
+ integer +
+ 		+ Default:
3600
+ 		+
How many seconds to wait. Cluster creation can take up to 20-30 minutes.
+
+
+ + +Notes +----- + +.. note:: + - All operations are time consuming, for example create takes 20-30 minutes, update kafka version -- more than one hour, update configuration -- 10-15 minutes; + - Cluster's brokers get evenly distributed over a number of availability zones that's equal to the number of subnets. + - If parameters 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`` + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + + + +Examples +-------- + +.. code-block:: yaml + + # Note: These examples do not set authentication details, see the AWS Guide for details. + + - aws_msk_cluster: + name: kafka-cluster + state: present + version: 2.6.1 + nodes: 6 + ebs_volume_size: "{{ aws_msk_options.ebs_volume_size }}" + subnets: + - subnet-e3b48ce7c25861eeb + - subnet-2990c8b25b07ddd43 + - subnet-d9fbeaf46c54bfab6 + wait: true + wait_timeout: 1800 + configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1 + configuration_revision: 1 + + - aws_msk_cluster: + name: kafka-cluster + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ bootstrap_broker_string + +
+ complex +
+ 		state=present and cluster state is ACTIVE +
A list of brokers that a client application can use to bootstrap.
+
+
  +
+ plain + +
+ string +
+ 		+
A string containing one or more hostname:port pairs.
+
+
  +
+ tls + +
+ string +
+ 		+
A string containing one or more DNS names (or IP) and TLS port pairs.
+
+
+
+ cluster_info + +
+ dictionary +
+ 		state=present +
Description of the MSK cluster.
+
+
+
+ response + +
+ dictionary +
+ 		always +
The response from actual API call.
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_msk_config_module.rst b/docs/community.aws.aws_msk_config_module.rst new file mode 100644 index 00000000000..37fc97d7ac0 --- /dev/null +++ b/docs/community.aws.aws_msk_config_module.rst @@ -0,0 +1,435 @@ +.. _community.aws.aws_msk_config_module: + + +**************************** +community.aws.aws_msk_config +**************************** + +**Manage Amazon MSK cluster configurations.** + + +Version added: 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) cluster configurations. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- boto3 +- boto3 >= 1.15.0 +- botocore >= 1.17.48 +- botocore >= 1.18.0 +- python >= 3.6 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aws_access_key + +
+ string +
+ 		+ +
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_ca_bundle + +
+ path +
+ 		+ +
The location of a CA Bundle to use when validating SSL certificates.
+
Not used by boto 2 based modules.
+
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+
+
+ aws_config + +
+ dictionary +
+ 		+ +
A dictionary to modify the botocore configuration.
+ +
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+
+
+ aws_secret_key + +
+ string +
+ 		+ +
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
+
+
+ config + +
+ dictionary +
+ 		+ +
Contents of the server.properties file.
+

aliases: configuration
+
+
+ debug_botocore_endpoint_logs + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+
+
+ description + +
+ string +
+ 		+ +
The description of the configuration.
+
+
+ ec2_url + +
+ string +
+ 		+ +
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
+
+
+ kafka_versions + +
+ list + / elements=string +
+ 		+ +
The versions of Apache Kafka with which you can use this MSK configuration.
+
Required when state=present.
+
+
+ name + +
+ string + / required +
+ 		+ +
The name of the configuration.
+
+
+ profile + +
+ string +
+ 		+ +
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
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ security_token + +
+ 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
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Create (present) or delete (absent) cluster configuration.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+
+ + +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_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`` + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + + + +Examples +-------- + +.. code-block:: yaml + + # Note: These examples do not set authentication details, see the AWS Guide for details. + + - aws_msk_config: + name: kafka-cluster-configuration + state: present + kafka_versions: + - 2.6.0 + - 2.6.1 + config: + auto.create.topics.enable: false + num.partitions: 1 + default.replication.factor: 3 + zookeeper.session.timeout.ms: 18000 + + - aws_msk_config: + name: kafka-cluster-configuration + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ arn + +
+ string +
+ 		state=present +
The Amazon Resource Name (ARN) of the configuration.
+
+
Sample:
+
arn:aws:kafka:<region>:<account>:configuration/<name>/<resource-id>
+
+
+ response + +
+ dictionary +
+ 		always +
The response from actual API call.
+
+
+
+ revision + +
+ integer +
+ 		state=present +
The revision number.
+
+
Sample:
+
1
+
+
+ server_properties + +
+ string +
+ 		state=present +
Contents of the server.properties file.
+
+
Sample:
+
default.replication.factor=3 + num.io.threads=8 + zookeeper.session.timeout.ms=18000
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_region_info_module.rst b/docs/community.aws.aws_region_info_module.rst index dce1b7e7fe0..39b2d55c302 100644 --- a/docs/community.aws.aws_region_info_module.rst +++ b/docs/community.aws.aws_region_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -181,7 +180,6 @@ 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
@@ -215,7 +213,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -237,7 +235,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -249,8 +247,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_s3_bucket_info_module.rst b/docs/community.aws.aws_s3_bucket_info_module.rst index 4e8862e3d8c..f004a4c533f 100644 --- a/docs/community.aws.aws_s3_bucket_info_module.rst +++ b/docs/community.aws.aws_s3_bucket_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.4.4 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -308,6 +308,7 @@ Parameters
Retrive S3 ownership controls.
+
Access to bucket ownership controls requires botocore>=1.18.11.
@@ -482,7 +483,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -532,7 +533,6 @@ 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
@@ -566,7 +566,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -610,7 +610,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -622,8 +622,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_s3_cors_module.rst b/docs/community.aws.aws_s3_cors_module.rst index d0ca89d016d..03af570f9f7 100644 --- a/docs/community.aws.aws_s3_cors_module.rst +++ b/docs/community.aws.aws_s3_cors_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,7 +174,6 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -277,8 +277,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_secret_module.rst b/docs/community.aws.aws_secret_module.rst index 9b72a3f31a4..c350a06e078 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.aws_secret_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore>=1.10.0 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,7 +204,6 @@ 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
@@ -323,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -379,7 +377,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -391,8 +389,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_ses_identity_module.rst b/docs/community.aws.aws_ses_identity_module.rst index 9cc37367205..a439fa43a8a 100644 --- a/docs/community.aws.aws_ses_identity_module.rst +++ b/docs/community.aws.aws_ses_identity_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -311,7 +310,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -364,7 +363,6 @@ 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
@@ -398,7 +396,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -439,7 +437,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -451,8 +449,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_ses_identity_policy_module.rst b/docs/community.aws.aws_ses_identity_policy_module.rst index 177b0f20617..f97c858a62f 100644 --- a/docs/community.aws.aws_ses_identity_policy_module.rst +++ b/docs/community.aws.aws_ses_identity_policy_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -208,7 +207,6 @@ 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
@@ -242,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -295,8 +293,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_ses_rule_set_module.rst b/docs/community.aws.aws_ses_rule_set_module.rst index 8734e4ccac3..cf4454134db 100644 --- a/docs/community.aws.aws_ses_rule_set_module.rst +++ b/docs/community.aws.aws_ses_rule_set_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -76,7 +75,7 @@ Parameters -
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.
+
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
@@ -95,7 +94,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -128,7 +127,7 @@ Parameters -
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.
+
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
@@ -165,7 +164,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -216,7 +215,6 @@ 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
@@ -250,7 +248,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -291,7 +289,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -303,8 +301,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_sgw_info_module.rst b/docs/community.aws.aws_sgw_info_module.rst index 00f665a0dab..ee750483fe2 100644 --- a/docs/community.aws.aws_sgw_info_module.rst +++ b/docs/community.aws.aws_sgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -235,7 +235,6 @@ 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
@@ -269,7 +268,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -291,7 +290,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -303,8 +302,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_ssm_connection.rst b/docs/community.aws.aws_ssm_connection.rst index 5982f438b7e..d88a1b506f6 100644 --- a/docs/community.aws.aws_ssm_connection.rst +++ b/docs/community.aws.aws_ssm_connection.rst @@ -137,39 +137,39 @@ Parameters
- region + reconnection_retries
- - + integer
- Default:
"us-east-1"
+ Default:
3
-
var: ansible_aws_ssm_region
+
var: ansible_aws_ssm_retries
-
The region the EC2 instance is located.
+
Number of attempts to connect.
- retries + region
- integer + -
- Default:
3
+ Default:
"us-east-1"
-
var: ansible_aws_ssm_retries
+
var: ansible_aws_ssm_region
-
Number of attempts to connect.
+
The region the EC2 instance is located.
diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.aws_ssm_parameter_store_module.rst index 5e8a325f7bf..76b06dcbd77 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/docs/community.aws.aws_ssm_parameter_store_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -177,7 +176,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -246,7 +245,6 @@ 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
@@ -280,7 +278,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -363,7 +361,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -390,8 +388,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 0e9159f0aca..76bdb9dc4bb 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 @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -176,7 +177,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -254,7 +255,6 @@ 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
@@ -288,7 +288,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -325,7 +325,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -337,8 +337,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 7a863fdcba0..0706e8c3829 100644 --- a/docs/community.aws.aws_step_functions_state_machine_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -158,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +191,6 @@ 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
@@ -259,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -315,7 +315,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -327,8 +327,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_waf_condition_module.rst b/docs/community.aws.aws_waf_condition_module.rst index a22b1d2989d..008043e9466 100644 --- a/docs/community.aws.aws_waf_condition_module.rst +++ b/docs/community.aws.aws_waf_condition_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -436,7 +437,6 @@ 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
@@ -489,7 +489,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -555,7 +555,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -586,8 +586,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_waf_info_module.rst b/docs/community.aws.aws_waf_info_module.rst index afc3aba03f5..85e18d75544 100644 --- a/docs/community.aws.aws_waf_info_module.rst +++ b/docs/community.aws.aws_waf_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +174,6 @@ 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
@@ -208,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -261,8 +260,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_waf_rule_module.rst b/docs/community.aws.aws_waf_rule_module.rst index f0a3dee30c5..4a122fdc547 100644 --- a/docs/community.aws.aws_waf_rule_module.rst +++ b/docs/community.aws.aws_waf_rule_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -221,7 +222,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -271,7 +272,6 @@ 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
@@ -324,7 +324,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -396,8 +396,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.aws_waf_web_acl_module.rst b/docs/community.aws.aws_waf_web_acl_module.rst index b6031af80c4..117059745dd 100644 --- a/docs/community.aws.aws_waf_web_acl_module.rst +++ b/docs/community.aws.aws_waf_web_acl_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -161,7 +162,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -211,7 +212,6 @@ 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
@@ -352,7 +352,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -393,7 +393,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -424,8 +424,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudformation_exports_info_module.rst b/docs/community.aws.cloudformation_exports_info_module.rst index 8047723c9ed..9bd43334bb1 100644 --- a/docs/community.aws.cloudformation_exports_info_module.rst +++ b/docs/community.aws.cloudformation_exports_info_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.11.15 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,7 +158,6 @@ 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
@@ -192,7 +191,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -214,7 +213,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -226,8 +225,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudformation_stack_set_module.rst b/docs/community.aws.cloudformation_stack_set_module.rst index 268c58f6106..1ad9dd1f311 100644 --- a/docs/community.aws.cloudformation_stack_set_module.rst +++ b/docs/community.aws.cloudformation_stack_set_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3>=1.6 -- botocore>=1.10.26 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -88,7 +87,7 @@ Parameters -
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.
+
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
@@ -107,7 +106,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -140,7 +139,7 @@ Parameters -
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.
+
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
@@ -214,7 +213,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -368,7 +367,6 @@ 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
@@ -439,7 +437,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -549,7 +547,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -598,8 +596,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudfront_distribution_module.rst b/docs/community.aws.cloudfront_distribution_module.rst index 7fe2ada6fa1..4274b12a5cc 100644 --- a/docs/community.aws.cloudfront_distribution_module.rst +++ b/docs/community.aws.cloudfront_distribution_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.0.0 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -85,7 +85,7 @@ Parameters -
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.
+
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
@@ -104,7 +104,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -137,7 +137,7 @@ Parameters -
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.
+
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
@@ -1314,7 +1314,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1719,10 +1719,44 @@ Parameters
Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront.
-
Will automatically create an Identity for you.
+
Will automatically create an Identity for you if no s3_origin_config is specified.
+ + + +
+ s3_origin_config + +
+ dictionary +
+ + + + +
Specify origin access identity for S3 origins.
+ + + + + + +
+ origin_access_identity + +
+ string +
+ + + + +
Existing origin access identity in the format origin-access-identity/cloudfront/OID_ID.
+ + + @@ -1756,7 +1790,6 @@ 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
@@ -1958,7 +1991,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -2017,7 +2050,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -2184,8 +2217,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -4444,6 +4478,44 @@ Common return values are documented `here + +   +   + +
+ s3_origin_config + +
+ dictionary +
+ + when s3_origin_access_identity_enabled is true + +
Origin access identity configuration for S3 Origin.
+
+ + + +   +   +   + +
+ origin_access_identity + +
+ string +
+ + + +
The origin access id as a path.
+
+
Sample:
+
origin-access-identity/cloudfront/EXAMPLEID
+ + +   diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 3bc0915dd8d..9766f960ce7 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.0.0 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -73,7 +73,7 @@ Parameters -
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.
+
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
@@ -92,7 +92,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +125,7 @@ Parameters -
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.
+
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
@@ -232,7 +232,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -437,7 +437,6 @@ 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
@@ -471,7 +470,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -553,7 +552,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -565,8 +564,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudfront_invalidation_module.rst b/docs/community.aws.cloudfront_invalidation_module.rst index eef95720fe4..1b64c27ef53 100644 --- a/docs/community.aws.cloudfront_invalidation_module.rst +++ b/docs/community.aws.cloudfront_invalidation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.0.0 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -189,7 +189,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,7 +205,6 @@ 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
@@ -239,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -278,7 +277,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -291,8 +290,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudfront_origin_access_identity_module.rst b/docs/community.aws.cloudfront_origin_access_identity_module.rst index 69a2da9de57..45ffd8bb0c8 100644 --- a/docs/community.aws.cloudfront_origin_access_identity_module.rst +++ b/docs/community.aws.cloudfront_origin_access_identity_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.0.0 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -203,7 +203,6 @@ 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
@@ -237,7 +236,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -278,7 +277,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -291,8 +290,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudtrail_module.rst b/docs/community.aws.cloudtrail_module.rst index b124fa5915e..3f3baa82c07 100644 --- a/docs/community.aws.cloudtrail_module.rst +++ b/docs/community.aws.cloudtrail_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -177,7 +176,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -306,7 +305,6 @@ 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
@@ -373,7 +371,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -451,7 +449,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -463,8 +461,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudwatchevent_rule_module.rst b/docs/community.aws.cloudwatchevent_rule_module.rst index ec1834b10d7..441d276d550 100644 --- a/docs/community.aws.cloudwatchevent_rule_module.rst +++ b/docs/community.aws.cloudwatchevent_rule_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,7 +204,6 @@ 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
@@ -268,7 +267,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -462,7 +461,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -476,8 +475,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst index 3635b8f5839..6206c9deba1 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -209,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -243,8 +241,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 c0e448046ba..350ac92429c 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -287,7 +286,6 @@ 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
@@ -321,7 +319,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -363,7 +361,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -375,8 +373,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.cloudwatchlogs_log_group_module.rst b/docs/community.aws.cloudwatchlogs_log_group_module.rst index 2dbc487ef7c..17ceecb94bc 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -211,7 +209,6 @@ 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
@@ -282,7 +279,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -338,7 +335,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -351,8 +348,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.data_pipeline_module.rst b/docs/community.aws.data_pipeline_module.rst index 167cf82e78a..08740070baa 100644 --- a/docs/community.aws.data_pipeline_module.rst +++ b/docs/community.aws.data_pipeline_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -398,7 +398,6 @@ 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
@@ -432,7 +431,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -506,7 +505,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -582,8 +581,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.dms_endpoint_module.rst b/docs/community.aws.dms_endpoint_module.rst index 6c1730d99e4..38fe9ee552f 100644 --- a/docs/community.aws.dms_endpoint_module.rst +++ b/docs/community.aws.dms_endpoint_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -201,7 +202,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -404,7 +405,6 @@ 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
@@ -469,7 +469,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -607,7 +607,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -638,8 +638,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.dms_replication_subnet_group_module.rst b/docs/community.aws.dms_replication_subnet_group_module.rst index 25e0fa5b98d..f6b208ddff4 100644 --- a/docs/community.aws.dms_replication_subnet_group_module.rst +++ b/docs/community.aws.dms_replication_subnet_group_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,7 +190,6 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -293,8 +293,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.dynamodb_table_module.rst b/docs/community.aws.dynamodb_table_module.rst index 8de198abe68..a4c0979d3b6 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -27,10 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto >= 2.37.0 -- boto3 >= 1.4.4 (for tagging) -- python >= 2.6 +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -381,7 +381,6 @@ 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
@@ -466,7 +465,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -523,7 +522,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -567,8 +566,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.dynamodb_ttl_module.rst b/docs/community.aws.dynamodb_ttl_module.rst index 99a2502b13c..50ed4076859 100644 --- a/docs/community.aws.dynamodb_ttl_module.rst +++ b/docs/community.aws.dynamodb_ttl_module.rst @@ -17,8 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Uses boto3 to set TTL. -- Requires botocore version 1.5.24 or higher. +- Sets the TTL for a given DynamoDB table. @@ -26,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore>=1.5.24 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -72,7 +70,7 @@ Parameters -
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.
+
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
@@ -91,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +122,7 @@ Parameters -
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.
+
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
@@ -161,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -177,7 +175,6 @@ 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
@@ -211,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -280,8 +277,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_ami_copy_module.rst b/docs/community.aws.ec2_ami_copy_module.rst index 42c5f779dff..bb3feebab07 100644 --- a/docs/community.aws.ec2_ami_copy_module.rst +++ b/docs/community.aws.ec2_ami_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,7 +223,6 @@ 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
@@ -257,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -345,7 +344,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -395,8 +394,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_asg_info_module.rst b/docs/community.aws.ec2_asg_info_module.rst index 5f7e4ae800f..64df8d3cf18 100644 --- a/docs/community.aws.ec2_asg_info_module.rst +++ b/docs/community.aws.ec2_asg_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +175,6 @@ 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
@@ -209,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +245,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -258,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst index e950d3b0b3e..c093c9d89a6 100644 --- a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst +++ b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3>=1.4.4 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,7 +259,6 @@ 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
@@ -308,7 +307,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -370,7 +369,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -382,8 +381,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_asg_module.rst b/docs/community.aws.ec2_asg_module.rst index ca3cdbf4ee0..4422e8af239 100644 --- a/docs/community.aws.ec2_asg_module.rst +++ b/docs/community.aws.ec2_asg_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -192,7 +191,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -709,7 +708,6 @@ 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
@@ -794,7 +792,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -911,7 +909,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -974,8 +972,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_customer_gateway_info_module.rst b/docs/community.aws.ec2_customer_gateway_info_module.rst index 3d08a50f855..8034b96949c 100644 --- a/docs/community.aws.ec2_customer_gateway_info_module.rst +++ b/docs/community.aws.ec2_customer_gateway_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +190,6 @@ 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
@@ -224,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +245,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -258,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_customer_gateway_module.rst b/docs/community.aws.ec2_customer_gateway_module.rst index 9d81a8bcb54..a38ee5dfe0c 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,7 +205,6 @@ 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
@@ -259,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -300,7 +298,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -314,8 +312,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_eip_info_module.rst b/docs/community.aws.ec2_eip_info_module.rst index d742f823cc0..2cfcd570736 100644 --- a/docs/community.aws.ec2_eip_info_module.rst +++ b/docs/community.aws.ec2_eip_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +175,6 @@ 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
@@ -208,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -242,8 +242,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_eip_module.rst b/docs/community.aws.ec2_eip_module.rst index dd674bbb9d4..921e424b8ba 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -72,7 +73,7 @@ Parameters -
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.
+
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
@@ -91,7 +92,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +125,7 @@ Parameters -
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.
+
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
@@ -178,7 +179,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -229,7 +230,6 @@ 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
@@ -334,7 +334,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -406,7 +406,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -435,8 +435,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_elb_info_module.rst b/docs/community.aws.ec2_elb_info_module.rst index 7689fb8882f..4ccc2a76a92 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -14,6 +14,13 @@ Version added: 1.0.0 :local: :depth: 1 +DEPRECATED +---------- +:Removed in collection release after +:Why: The ec2_elb_info is based upon a deprecated version of the AWS SDK. +:Alternative: Use :ref:`elb_classic_lb_info `. + + Synopsis -------- @@ -26,8 +33,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -53,7 +62,7 @@ Parameters -
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.
+
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
@@ -72,7 +81,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +114,7 @@ Parameters -
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.
+
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
@@ -142,7 +151,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +183,6 @@ 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
@@ -208,7 +216,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +238,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -242,8 +250,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -288,6 +297,10 @@ Status ------ +- This module will be removed in version 3.0.0. *[deprecated]* +- For more information see `DEPRECATED`_. + + Authors ~~~~~~~ diff --git a/docs/community.aws.ec2_launch_template_module.rst b/docs/community.aws.ec2_launch_template_module.rst index 3bec3a190f9..0df31038a64 100644 --- a/docs/community.aws.ec2_launch_template_module.rst +++ b/docs/community.aws.ec2_launch_template_module.rst @@ -18,7 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups. -- The :ref:`community.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. +- The :ref:`amazon.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.6.0 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -490,7 +489,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1154,7 +1153,6 @@ 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
@@ -1235,7 +1233,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1341,7 +1339,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -1353,8 +1351,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_lc_find_module.rst b/docs/community.aws.ec2_lc_find_module.rst index 803e4898d12..b4ef0e22906 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,7 +194,6 @@ 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
@@ -228,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -269,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -281,8 +280,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_lc_info_module.rst b/docs/community.aws.ec2_lc_info_module.rst index e8b6bcecd0b..c69ad922727 100644 --- a/docs/community.aws.ec2_lc_info_module.rst +++ b/docs/community.aws.ec2_lc_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +176,6 @@ 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
@@ -210,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -308,7 +307,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -320,8 +319,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_lc_module.rst b/docs/community.aws.ec2_lc_module.rst index af1f0bff3f3..2ce6e3fdd6f 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.4.4 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -92,7 +92,7 @@ Parameters -
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.
+
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
@@ -111,7 +111,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -144,7 +144,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -393,7 +393,6 @@ 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
@@ -458,7 +457,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -544,7 +543,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -754,8 +753,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_metric_alarm_module.rst b/docs/community.aws.ec2_metric_alarm_module.rst index c15290999b5..d55e599ddc7 100644 --- a/docs/community.aws.ec2_metric_alarm_module.rst +++ b/docs/community.aws.ec2_metric_alarm_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -69,7 +70,7 @@ Parameters -
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.
+
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
@@ -88,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +122,7 @@ Parameters -
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.
+
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
@@ -216,7 +217,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -341,7 +342,6 @@ 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
@@ -375,7 +375,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -519,7 +519,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -531,8 +531,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_placement_group_info_module.rst b/docs/community.aws.ec2_placement_group_info_module.rst index e231cde5eab..afc05c66621 100644 --- a/docs/community.aws.ec2_placement_group_info_module.rst +++ b/docs/community.aws.ec2_placement_group_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +176,6 @@ 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
@@ -209,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -243,8 +243,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_placement_group_module.rst b/docs/community.aws.ec2_placement_group_module.rst index 8c9186c2349..eda2dffdb8e 100644 --- a/docs/community.aws.ec2_placement_group_module.rst +++ b/docs/community.aws.ec2_placement_group_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,7 +174,6 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -267,7 +267,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -279,8 +279,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_scaling_policy_module.rst b/docs/community.aws.ec2_scaling_policy_module.rst index 76dab5ffd11..a5a0ac17605 100644 --- a/docs/community.aws.ec2_scaling_policy_module.rst +++ b/docs/community.aws.ec2_scaling_policy_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -90,7 +91,7 @@ Parameters -
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.
+
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
@@ -109,7 +110,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -142,7 +143,7 @@ Parameters -
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.
+
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
@@ -195,7 +196,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -298,7 +299,6 @@ 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
@@ -350,7 +350,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -461,7 +461,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -473,8 +473,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_snapshot_copy_module.rst b/docs/community.aws.ec2_snapshot_copy_module.rst index f3f55ee91e5..9f93e140860 100644 --- a/docs/community.aws.ec2_snapshot_copy_module.rst +++ b/docs/community.aws.ec2_snapshot_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -207,7 +207,6 @@ 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
@@ -241,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -310,7 +309,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -357,8 +356,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_transit_gateway_info_module.rst b/docs/community.aws.ec2_transit_gateway_info_module.rst index 052da82c68b..27c90dc71ac 100644 --- a/docs/community.aws.ec2_transit_gateway_info_module.rst +++ b/docs/community.aws.ec2_transit_gateway_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +173,6 @@ 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
@@ -208,7 +206,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +245,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -259,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_transit_gateway_module.rst b/docs/community.aws.ec2_transit_gateway_module.rst index 669edfae9bb..18f76c66a2d 100644 --- a/docs/community.aws.ec2_transit_gateway_module.rst +++ b/docs/community.aws.ec2_transit_gateway_module.rst @@ -27,10 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -129,7 +128,7 @@ Parameters -
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.
+
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
@@ -148,7 +147,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -181,7 +180,7 @@ Parameters -
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.
+
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
@@ -252,7 +251,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -268,7 +267,6 @@ 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
@@ -321,7 +319,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -393,7 +391,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -459,8 +457,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_egress_igw_module.rst b/docs/community.aws.ec2_vpc_egress_igw_module.rst index 6d309eab2b7..4043cf775d6 100644 --- a/docs/community.aws.ec2_vpc_egress_igw_module.rst +++ b/docs/community.aws.ec2_vpc_egress_igw_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -157,7 +158,6 @@ 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
@@ -191,7 +191,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -232,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -260,8 +260,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_nacl_info_module.rst b/docs/community.aws.ec2_vpc_nacl_info_module.rst index 2a433f70523..e690d470631 100644 --- a/docs/community.aws.ec2_vpc_nacl_info_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,7 +193,6 @@ 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
@@ -227,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +248,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -262,8 +261,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_nacl_module.rst b/docs/community.aws.ec2_vpc_nacl_module.rst index d935d3377be..329f218f0bc 100644 --- a/docs/community.aws.ec2_vpc_nacl_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -226,7 +224,6 @@ 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
@@ -260,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +332,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -363,8 +360,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_peer_module.rst b/docs/community.aws.ec2_vpc_peer_module.rst index c59ff562990..f6183111a62 100644 --- a/docs/community.aws.ec2_vpc_peer_module.rst +++ b/docs/community.aws.ec2_vpc_peer_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -220,12 +218,31 @@ 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
+ + +
+ purge_tags + +
+ boolean +
+
added in 2.0.0
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Remove tags not listed in tags.
+ +
@@ -254,7 +271,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -312,7 +329,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -358,8 +375,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_peering_info_module.rst b/docs/community.aws.ec2_vpc_peering_info_module.rst index 64d7086b0f2..c23282c99b1 100644 --- a/docs/community.aws.ec2_vpc_peering_info_module.rst +++ b/docs/community.aws.ec2_vpc_peering_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +190,6 @@ 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
@@ -224,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +245,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -258,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. 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 18265c7b2fe..59976e4a317 100644 --- a/docs/community.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,7 +174,6 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -241,8 +241,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_route_table_module.rst b/docs/community.aws.ec2_vpc_route_table_module.rst index b083c49731f..0468df68e68 100644 --- a/docs/community.aws.ec2_vpc_route_table_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +177,6 @@ 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
@@ -316,7 +316,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -389,7 +389,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -417,8 +417,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_vgw_info_module.rst b/docs/community.aws.ec2_vpc_vgw_info_module.rst index a61eb76c01b..307b0fa3046 100644 --- a/docs/community.aws.ec2_vpc_vgw_info_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +174,6 @@ 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
@@ -208,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -258,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_vgw_module.rst b/docs/community.aws.ec2_vpc_vgw_module.rst index b6654ad119f..5da685210ba 100644 --- a/docs/community.aws.ec2_vpc_vgw_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,7 +191,6 @@ 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
@@ -225,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -301,7 +300,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -359,8 +358,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_vpn_info_module.rst b/docs/community.aws.ec2_vpc_vpn_info_module.rst index b182e0279ba..be6c5130e75 100644 --- a/docs/community.aws.ec2_vpc_vpn_info_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +174,6 @@ 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
@@ -208,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -258,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_vpc_vpn_module.rst b/docs/community.aws.ec2_vpc_vpn_module.rst index b6fca122c45..b6dd8e5e6cb 100644 --- a/docs/community.aws.ec2_vpc_vpn_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -191,7 +190,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -383,7 +382,6 @@ 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
@@ -471,7 +469,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -595,7 +593,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -653,8 +651,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_win_password_module.rst b/docs/community.aws.ec2_win_password_module.rst index 4e3aca0c7af..ddba8b42e43 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -26,9 +26,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 - cryptography -- python >= 2.6 +- python >= 3.6 Parameters @@ -54,7 +56,7 @@ Parameters -
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.
+
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
@@ -73,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +108,7 @@ Parameters -
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.
+
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
@@ -143,7 +145,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -222,7 +224,6 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -278,7 +279,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -326,8 +327,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_attribute_module.rst b/docs/community.aws.ecs_attribute_module.rst index 6c9dc4f6e64..5948d4227bc 100644 --- a/docs/community.aws.ecs_attribute_module.rst +++ b/docs/community.aws.ecs_attribute_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -124,7 +123,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -157,7 +156,7 @@ Parameters -
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.
+
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
@@ -226,7 +225,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -242,7 +241,6 @@ 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
@@ -276,7 +274,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -317,7 +315,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -329,8 +327,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_cluster_module.rst b/docs/community.aws.ecs_cluster_module.rst index c198e3fcba4..d7f56836de7 100644 --- a/docs/community.aws.ecs_cluster_module.rst +++ b/docs/community.aws.ecs_cluster_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +190,6 @@ 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
@@ -240,7 +239,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -297,8 +296,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_ecr_module.rst b/docs/community.aws.ecs_ecr_module.rst index 853e153ab9d..8227a7a7e0e 100644 --- a/docs/community.aws.ecs_ecr_module.rst +++ b/docs/community.aws.ecs_ecr_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -242,7 +242,6 @@ 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
@@ -340,7 +339,6 @@ Parameters
if true, images are scanned for known vulnerabilities after being pushed to the repository.
-
scan_on_push requires botocore >= 1.13.3
@@ -355,7 +353,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -396,7 +394,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -408,8 +406,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_service_info_module.rst b/docs/community.aws.ecs_service_info_module.rst index 4d60e6d3480..39b3f073f96 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -26,11 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -56,7 +54,7 @@ Parameters -
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.
+
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
@@ -75,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +177,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -214,7 +212,6 @@ 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
@@ -248,7 +245,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -286,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -298,8 +295,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_service_module.rst b/docs/community.aws.ecs_service_module.rst index d510fe56790..dc0663aaa06 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -255,7 +253,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -291,7 +289,6 @@ Parameters
Seconds to wait before health checking the freshly added/updated services.
-
This option requires botocore >= 1.8.20.
@@ -358,7 +355,6 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
-
assign_public_ip requires botocore >= 1.8.4
@@ -379,7 +375,6 @@ Parameters
Whether the task's elastic network interface receives a public IP address.
-
This option requires botocore >= 1.8.4.
@@ -545,7 +540,6 @@ 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
@@ -631,7 +625,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -755,7 +749,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -770,8 +764,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index bbd6c2f793f..d3b69c383ea 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +175,6 @@ 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
@@ -268,7 +266,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -325,7 +323,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -338,8 +336,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_task_module.rst b/docs/community.aws.ecs_task_module.rst index 128ef7f6971..5847ab1df45 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -191,7 +189,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -227,7 +225,6 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
-
assign_public_ip requires botocore >= 1.8.4
@@ -337,7 +334,6 @@ 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
@@ -371,7 +367,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -453,7 +449,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -465,8 +461,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_taskdefinition_info_module.rst b/docs/community.aws.ecs_taskdefinition_info_module.rst index 01f268e4ac5..efb12e4debf 100644 --- a/docs/community.aws.ecs_taskdefinition_info_module.rst +++ b/docs/community.aws.ecs_taskdefinition_info_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- json -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -160,7 +158,6 @@ 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
@@ -194,7 +191,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -232,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -246,8 +243,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ecs_taskdefinition_module.rst b/docs/community.aws.ecs_taskdefinition_module.rst index 0132cbad123..9de5fcbc0e3 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -25,11 +25,12 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto - boto3 +- boto3 >= 1.15.0 - botocore +- botocore >= 1.18.0 - json -- python >= 2.6 +- python >= 3.6 Parameters @@ -70,7 +71,7 @@ Parameters -
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.
+
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
@@ -89,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +123,7 @@ Parameters -
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.
+
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
@@ -612,7 +613,7 @@ Parameters linuxParameters
- list + dictionary
@@ -1584,6 +1585,23 @@ Parameters
+
    Choices: +
  • core
    • +
  • cpu
    • +
  • data
    • +
  • fsize
    • +
  • locks
    • +
  • memlock
    • +
  • msgqueue
    • +
  • nice
    • +
  • nofile
    • +
  • nproc
    • +
  • rss
    • +
  • rtprio
    • +
  • rttime
    • +
  • sigpending
    • +
  • stack
    • +
The type of the ulimit.
@@ -1745,7 +1763,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1870,7 +1888,6 @@ 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
@@ -1919,7 +1936,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1976,7 +1993,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -2022,8 +2039,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -2184,3 +2202,4 @@ Authors ~~~~~~~ - Mark Chance (@Java1Guy) +- Alina Buzachis (@alinabuzachis) diff --git a/docs/community.aws.efs_info_module.rst b/docs/community.aws.efs_info_module.rst index ab8ebd81da8..ebe311c9ec4 100644 --- a/docs/community.aws.efs_info_module.rst +++ b/docs/community.aws.efs_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +190,6 @@ 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
@@ -224,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -278,7 +277,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -290,8 +289,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -531,7 +531,7 @@ Common return values are documented `here float - when botocore >= 1.10.57 and throughput_mode is set to "provisioned" + when throughput_mode is set to "provisioned"
throughput provisioned in Mibps

@@ -582,7 +582,7 @@ Common return values are documented `here string - when botocore >= 1.10.57 + always
mode of throughput for the file system

diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 06279ae5a2b..60d6071897c 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -241,7 +241,6 @@ 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
@@ -260,7 +259,6 @@ Parameters
If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
-
Requires botocore >= 1.10.57
@@ -310,7 +308,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -434,7 +432,6 @@ Parameters
The throughput_mode for the file system to be created.
-
Requires botocore >= 1.10.57
@@ -453,7 +450,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -500,8 +497,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.ec2_elb_module.rst b/docs/community.aws.efs_tag_module.rst similarity index 72% rename from docs/community.aws.ec2_elb_module.rst rename to docs/community.aws.efs_tag_module.rst index 39b33d7c74b..838b239d74f 100644 --- a/docs/community.aws.ec2_elb_module.rst +++ b/docs/community.aws.efs_tag_module.rst @@ -1,14 +1,14 @@ -.. _community.aws.ec2_elb_module: +.. _community.aws.efs_tag_module: ********************* -community.aws.ec2_elb +community.aws.efs_tag ********************* -**De-registers or registers instances from EC2 ELBs** +**create and remove tags on Amazon EFS resources** -Version added: 1.0.0 +Version added: 2.0.0 .. contents:: :local: @@ -17,9 +17,8 @@ Version added: 1.0.0 Synopsis -------- -- This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. -- Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. -- Will be marked changed when called only if there are ELBs found to operate on. +- Creates and removes tags for Amazon EFS resources. +- Resources are referenced by their ID (filesystem or filesystem access point). @@ -27,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -134,24 +134,23 @@ Parameters
- ec2_elbs + ec2_url
- list - / elements=string + string
-
List of ELB names, required for registration.
-
The ec2_elbs fact should be used if there was a previous de-register.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
- ec2_url + profile
string @@ -160,14 +159,15 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
+
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
- enable_availability_zone + purge_tags
boolean @@ -175,34 +175,19 @@ Parameters
    Choices: -
  • no
    • -
  • yes ←
    • +
  • no ←
    • +
  • yes
-
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
+
Whether unspecified tags should be removed from the resource.
+
Note that when combined with state=absent, specified tags with non-matching values are not purged.
- instance_id - -
- string - / required -
- - - - -
EC2 Instance ID
- - - - -
- profile + region
string @@ -211,26 +196,24 @@ 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
+
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
- region + resource
string + / required
-
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
+
EFS Filesystem ID or EFS Filesystem Access Point ID.
@@ -245,7 +228,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -258,42 +241,39 @@ Parameters
string - / required
    Choices: -
  • present
    • +
  • present ←
  • absent
-
register or deregister the instance
+
Whether the tags should be present or absent on the resource.
- validate_certs + tags
- boolean + dictionary + / required
-
    Choices: -
  • no
    • -
  • yes ←
    • -
-
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
A dictionary of tags to add or remove from the resource.
+
If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
- wait + validate_certs
boolean @@ -306,23 +286,7 @@ Parameters -
Wait for instance registration or deregistration to complete successfully before returning.
- - - - -
- wait_timeout - -
- integer -
- - - Default:
0
- - -
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -334,8 +298,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -344,23 +309,97 @@ Examples .. code-block:: yaml - # basic pre_task and post_task example - pre_tasks: - - name: Instance De-register - community.aws.ec2_elb: - instance_id: "{{ ansible_ec2_instance_id }}" - state: absent - roles: - - myrole - post_tasks: - - name: Instance Register - community.aws.ec2_elb: - instance_id: "{{ ansible_ec2_instance_id }}" - ec2_elbs: "{{ item }}" - state: present - loop: "{{ ec2_elbs }}" + - name: Ensure tags are present on a resource + community.aws.efs_tag: + resource: fs-123456ab + state: present + tags: + Name: MyEFS + Env: Production + + - name: Remove the Env tag if it's currently 'development' + community.aws.efs_tag: + resource: fsap-78945ff + state: absent + tags: + Env: development + + - name: Remove all tags except for Name + community.aws.efs_tag: + resource: fsap-78945ff + state: absent + tags: + Name: foo + purge_tags: true + + - name: Remove all tags + community.aws.efs_tag: + resource: fsap-78945ff + state: absent + tags: {} + purge_tags: true + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ added_tags + +
+ dictionary +
+ 		If tags were added +
A dict of tags that were added to the resource
+
+
+
+ removed_tags + +
+ dictionary +
+ 		If tags were removed +
A dict of tags that were removed from the resource
+
+
+
+ tags + +
+ dictionary +
+ 		always +
A dict containing the tags on the resource
+
+
+

Status @@ -370,4 +409,4 @@ Status Authors ~~~~~~~ -- John Jarvis (@jarv) +- Milan Zink (@zeten30) diff --git a/docs/community.aws.elasticache_info_module.rst b/docs/community.aws.elasticache_info_module.rst index 34254514c00..775b3d36441 100644 --- a/docs/community.aws.elasticache_info_module.rst +++ b/docs/community.aws.elasticache_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,7 +174,6 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -241,8 +241,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elasticache_module.rst b/docs/community.aws.elasticache_module.rst index 0466cff2964..eb3c8e43697 100644 --- a/docs/community.aws.elasticache_module.rst +++ b/docs/community.aws.elasticache_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -222,7 +222,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -324,7 +324,6 @@ 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
@@ -374,7 +373,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -418,7 +417,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -464,8 +463,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elasticache_parameter_group_module.rst b/docs/community.aws.elasticache_parameter_group_module.rst index d7554eb5d56..3f93a6865e5 100644 --- a/docs/community.aws.elasticache_parameter_group_module.rst +++ b/docs/community.aws.elasticache_parameter_group_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -215,7 +214,6 @@ 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
@@ -249,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -292,7 +290,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -319,8 +317,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elasticache_snapshot_module.rst b/docs/community.aws.elasticache_snapshot_module.rst index 73ccdec22d3..28218326b5e 100644 --- a/docs/community.aws.elasticache_snapshot_module.rst +++ b/docs/community.aws.elasticache_snapshot_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -174,7 +173,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,7 +205,6 @@ 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
@@ -255,7 +253,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -313,7 +311,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -325,8 +323,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elasticache_subnet_group_module.rst b/docs/community.aws.elasticache_subnet_group_module.rst index cedd9859da5..260f6a84026 100644 --- a/docs/community.aws.elasticache_subnet_group_module.rst +++ b/docs/community.aws.elasticache_subnet_group_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. +- Creates, modifies, and deletes ElastiCache subnet groups. @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,8 @@ Parameters -
ElastiCache subnet group description. Only set when a new group is added.
+
ElastiCache subnet group description.
+
When not provided defaults to name on subnet group creation.
@@ -156,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +176,7 @@ Parameters
Database subnet group identifier.
+
This value is automatically converted to lowercase.
@@ -188,7 +191,6 @@ 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
@@ -222,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -235,12 +237,11 @@ Parameters
string - / required
    Choices: -
  • present
    • +
  • present ←
  • absent
@@ -262,6 +263,7 @@ Parameters
List of subnet IDs that make up the ElastiCache subnet group.
+
At least one subnet must be provided when creating an ElastiCache subnet group.
@@ -280,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -292,8 +294,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -318,6 +321,128 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ cache_subnet_group + +
+ dictionary +
+ 		always +
Description of the Elasticache Subnet Group.
+
+
  +
+ arn + +
+ string +
+ 		when the subnet group exists +
The Amazon Resource Name (ARN) of the cache subnet group.
+
+
Sample:
+
arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue
+
  +
+ description + +
+ string +
+ 		when the cache subnet group exists +
The description of the cache subnet group.
+
+
Sample:
+
My Fancy Ex Parrot Subnet Group
+
  +
+ name + +
+ string +
+ 		when the cache subnet group exists +
The name of the cache subnet group.
+
+
Sample:
+
norwegian-blue
+
  +
+ subnet_ids + +
+ list + / elements=string +
+ 		when the cache subnet group exists +
The IDs of the subnets beloging to the cache subnet group.
+
+
Sample:
+
['subnet-aaaaaaaa', 'subnet-bbbbbbbb']
+
  +
+ vpc_id + +
+ string +
+ 		when the cache subnet group exists +
The VPC ID of the cache subnet group.
+
+
Sample:
+
norwegian-blue
+
+

+ Status ------ diff --git a/docs/community.aws.elb_application_lb_info_module.rst b/docs/community.aws.elb_application_lb_info_module.rst index ef71064e90b..d511a3ddc24 100644 --- a/docs/community.aws.elb_application_lb_info_module.rst +++ b/docs/community.aws.elb_application_lb_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,7 +191,6 @@ 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
@@ -225,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -259,8 +258,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -332,7 +332,7 @@ Common return values are documented `here string
- when status is present +
The name of the S3 bucket for the access logs.

@@ -350,7 +350,7 @@ Common return values are documented `here string
- when status is present +
Indicates whether access logs stored in Amazon S3 are enabled.

@@ -368,7 +368,7 @@ Common return values are documented `here string
- when status is present +
The prefix for the location in the S3 bucket.

@@ -386,7 +386,7 @@ Common return values are documented `here list
- when status is present +
The Availability Zones for the load balancer.

@@ -404,7 +404,7 @@ Common return values are documented `here string - when status is present +
The ID of the Amazon Route 53 hosted zone associated with the load balancer.

@@ -422,7 +422,7 @@ Common return values are documented `here string - when status is present +
The date and time the load balancer was created.

@@ -440,7 +440,7 @@ Common return values are documented `here string - when status is present +
Indicates whether deletion protection is enabled.

@@ -458,7 +458,7 @@ Common return values are documented `here string - when status is present +
The public DNS name of the load balancer.

@@ -476,7 +476,7 @@ Common return values are documented `here string - when status is present +
The idle timeout value, in seconds.

@@ -494,7 +494,7 @@ Common return values are documented `here string - when status is present +
The type of IP addresses used by the subnets for the load balancer.

@@ -512,7 +512,7 @@ Common return values are documented `here string - when status is present +
The Amazon Resource Name (ARN) of the load balancer.

@@ -530,7 +530,7 @@ Common return values are documented `here string - when status is present +
The name of the load balancer.

@@ -548,7 +548,7 @@ Common return values are documented `here string - when status is present +
Internet-facing or internal load balancer.

@@ -566,7 +566,7 @@ Common return values are documented `here list - when status is present +
The IDs of the security groups for the load balancer.

@@ -584,7 +584,7 @@ Common return values are documented `here dictionary - when status is present +
The state of the load balancer.

@@ -602,7 +602,7 @@ Common return values are documented `here dictionary - when status is present +
The tags attached to the load balancer.

@@ -620,7 +620,7 @@ Common return values are documented `here string - when status is present +
The type of load balancer.

@@ -638,7 +638,7 @@ Common return values are documented `here string - when status is present +
The ID of the VPC for the load balancer.

diff --git a/docs/community.aws.elb_application_lb_module.rst b/docs/community.aws.elb_application_lb_module.rst index cae74399a5d..020d3b34212 100644 --- a/docs/community.aws.elb_application_lb_module.rst +++ b/docs/community.aws.elb_application_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -127,7 +127,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -160,7 +160,7 @@ Parameters -
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.
+
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
@@ -217,7 +217,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -256,6 +256,25 @@ Parameters
The number of seconds to wait before an idle connection is closed.
+ + +
+ ip_address_type + +
+ string +
+ + +
    Choices: +
  • ipv4
    • +
  • dualstack
    • +
+ + +
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
+ +
@@ -510,7 +529,6 @@ 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
@@ -640,7 +658,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -713,7 +731,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -761,8 +779,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_classic_lb_info_module.rst b/docs/community.aws.elb_classic_lb_info_module.rst index a6a90f89ee5..fcc2bc01b6b 100644 --- a/docs/community.aws.elb_classic_lb_info_module.rst +++ b/docs/community.aws.elb_classic_lb_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +175,6 @@ 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
@@ -210,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -232,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -244,8 +242,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_classic_lb_module.rst b/docs/community.aws.elb_classic_lb_module.rst deleted file mode 100644 index 85612a0453c..00000000000 --- a/docs/community.aws.elb_classic_lb_module.rst +++ /dev/null @@ -1,843 +0,0 @@ -.. _community.aws.elb_classic_lb_module: - - -**************************** -community.aws.elb_classic_lb -**************************** - -**Creates or destroys Amazon ELB.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about the load balancer. -- Will be marked changed when called only if state is changed. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- python >= 2.6 -- boto - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access_logs - -
- dictionary -
- 		- -
An associative array of access logs configuration settings (see example).
-
-
- aws_access_key - -
- string -
- 		- -
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_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
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
-
-
- connection_draining_timeout - -
- integer -
- 		- -
Wait a specified timeout allowing connections to drain before terminating an instance.
-
-
- cross_az_load_balancing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distribute load across all configured Availability Zones.
-
Defaults to false.
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- ec2_url - -
- string -
- 		- -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- health_check - -
- dictionary -
- 		- -
An associative array of health check configuration settings (see example).
-
-
- idle_timeout - -
- integer -
- 		- -
ELB connections from clients and to servers are timed out after this amount of time.
-
-
- instance_ids - -
- list - / elements=string -
- 		- -
List of instance ids to attach to this ELB.
-
-
- listeners - -
- list - / elements=dictionary -
- 		- -
List of ports/protocols for this ELB to listen on (see example).
-
-
- name - -
- string - / required -
- 		- -
The name of the ELB.
-
-
- profile - -
- 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
-
-
- purge_instance_ids - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing instance ids on ELB that are not found in instance_ids.
-
-
- purge_listeners - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Purge existing listeners on ELB that are not found in listeners.
-
-
- purge_subnets - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing subnets on ELB that are not found in subnets.
-
-
- purge_zones - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing availability zones on ELB that are not found in zones.
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- scheme - -
- string -
- 		-
    Choices: -
  • internal
    • -
  • internet-facing ←
    • -
- 		-
The scheme to use when creating the ELB.
-
For a private VPC-visible ELB use internal.
-
If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must set wait=true.
-
-
- security_group_ids - -
- list - / elements=string -
- 		- -
A list of security groups to apply to the ELB.
-
-
- security_group_names - -
- list - / elements=string -
- 		- -
A list of security group names to apply to the ELB.
-
-
- security_token - -
- 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
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
Create or destroy the ELB.
-
-
- stickiness - -
- dictionary -
- 		- -
An associative array of stickiness policy settings. Policy will be applied to all listeners (see example).
-
-
- subnets - -
- list - / elements=string -
- 		- -
A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
-
-
- tags - -
- dictionary -
- 		- -
An associative array of tags. To delete all tags, supply an empty dict.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to false, SSL certificates will not be validated for boto versions >= 2.6.0.
-
-
- wait - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
-
-
- wait_timeout - -
- integer -
- 		- Default:
60
- 		-
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated. A maximum of 600 seconds (10 minutes) is allowed.
-
-
- zones - -
- list - / elements=string -
- 		- -
List of availability zones to enable on this ELB.
-
-
- - -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_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 - - - -Examples --------- - -.. code-block:: yaml - - # Note: None of these examples set aws_access_key, aws_secret_key, or region. - # It is assumed that their matching environment variables are set. - - # Basic provisioning example (non-VPC) - - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http # options are http, https, ssl, tcp - load_balancer_port: 80 - instance_port: 80 - proxy_protocol: True - - protocol: https - load_balancer_port: 443 - instance_protocol: http # optional, defaults to value of protocol setting - instance_port: 80 - # ssl certificate required for https or ssl - ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert" - delegate_to: localhost - - # Internal ELB example - - - community.aws.elb_classic_lb: - name: "test-vpc" - scheme: internal - state: present - instance_ids: - - i-abcd1234 - purge_instance_ids: true - subnets: - - subnet-abcd1234 - - subnet-1a2b3c4d - listeners: - - protocol: http # options are http, https, ssl, tcp - load_balancer_port: 80 - instance_port: 80 - delegate_to: localhost - - # Configure a health check and the access logs - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - health_check: - ping_protocol: http # options are http, https, ssl, tcp - ping_port: 80 - ping_path: "/index.html" # not required for tcp or ssl - response_timeout: 5 # seconds - interval: 30 # seconds - unhealthy_threshold: 2 - healthy_threshold: 10 - access_logs: - interval: 5 # minutes (defaults to 60) - s3_location: "my-bucket" # This value is required if access_logs is set - s3_prefix: "logs" - delegate_to: localhost - - # Ensure ELB is gone - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: absent - delegate_to: localhost - - # Ensure ELB is gone and wait for check (for default timeout) - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: absent - wait: yes - delegate_to: localhost - - # Ensure ELB is gone and wait for check with timeout value - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: absent - wait: yes - wait_timeout: 600 - delegate_to: localhost - - # Normally, this module will purge any listeners that exist on the ELB - # but aren't specified in the listeners parameter. If purge_listeners is - # false it leaves them alone - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - purge_listeners: no - delegate_to: localhost - - # Normally, this module will leave availability zones that are enabled - # on the ELB alone. If purge_zones is true, then any extraneous zones - # will be removed - - community.aws.elb_classic_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - purge_zones: yes - delegate_to: localhost - - # Creates a ELB and assigns a list of subnets to it. - - community.aws.elb_classic_lb: - state: present - name: 'New ELB' - security_group_ids: 'sg-123456, sg-67890' - region: us-west-2 - subnets: 'subnet-123456,subnet-67890' - purge_subnets: yes - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - delegate_to: localhost - - # Create an ELB with connection draining, increased idle timeout and cross availability - # zone load balancing - - community.aws.elb_classic_lb: - name: "New ELB" - state: present - connection_draining_timeout: 60 - idle_timeout: 300 - cross_az_load_balancing: "yes" - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - delegate_to: localhost - - # Create an ELB with load balancer stickiness enabled - - community.aws.elb_classic_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - stickiness: - type: loadbalancer - enabled: yes - expiration: 300 - delegate_to: localhost - - # Create an ELB with application stickiness enabled - - community.aws.elb_classic_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - stickiness: - type: application - enabled: yes - cookie: SESSIONID - delegate_to: localhost - - # Create an ELB and add tags - - community.aws.elb_classic_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - tags: - Name: "New ELB" - stack: "production" - client: "Bob" - delegate_to: localhost - - # Delete all tags from an ELB - - community.aws.elb_classic_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - tags: {} - delegate_to: localhost - - - - -Status ------- - - -Authors -~~~~~~~ - -- Jim Dalton (@jsdalton) diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index be68b327065..00248cbdebb 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -27,8 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -54,7 +56,7 @@ Parameters -
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.
+
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
@@ -73,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +108,7 @@ Parameters -
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.
+
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
@@ -144,7 +146,8 @@ Parameters -
List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
+
List of ELB names, required for registration.
+
The ec2_elbs fact should be used if there was a previous de-register.
@@ -159,7 +162,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -179,7 +182,8 @@ Parameters -
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
+
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled.
+
If enable_availability_zone=no, the task will fail if the availability zone is not enabled on the ELB.
@@ -210,7 +214,6 @@ 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
@@ -244,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -267,7 +270,7 @@ Parameters -
register or deregister the instance
+
Register or deregister the instance.
@@ -286,7 +289,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -321,7 +324,10 @@ Parameters Default:
0
-
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
+
Number of seconds to wait for an instance to change state.
+
If wait_timeout=0 then this module may return an error if a transient error occurs.
+
If non-zero then any transient errors are ignored until the timeout is reached.
+
Ignored when wait=no.
@@ -333,8 +339,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_network_lb_module.rst b/docs/community.aws.elb_network_lb_module.rst index 79895efaac0..fee52ab88f8 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -182,10 +182,29 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
+ + +
+ ip_address_type + +
+ string +
+ + +
    Choices: +
  • ipv4
    • +
  • dualstack
    • +
+ + +
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
+ +
@@ -369,7 +388,6 @@ 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
@@ -462,7 +480,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -554,7 +572,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -602,8 +620,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_target_group_info_module.rst b/docs/community.aws.elb_target_group_info_module.rst index 4ee35257c3c..3d300df03d3 100644 --- a/docs/community.aws.elb_target_group_info_module.rst +++ b/docs/community.aws.elb_target_group_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -162,7 +162,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,7 +209,6 @@ 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
@@ -243,7 +242,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +280,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -293,8 +292,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_target_group_module.rst b/docs/community.aws.elb_target_group_module.rst index 7549b81d275..9995592049d 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,7 +329,6 @@ 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
@@ -411,7 +410,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -620,7 +619,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -683,8 +682,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_target_info_module.rst b/docs/community.aws.elb_target_info_module.rst index 53d29e3295c..39b55cf4a69 100644 --- a/docs/community.aws.elb_target_info_module.rst +++ b/docs/community.aws.elb_target_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -195,7 +194,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -251,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -263,8 +261,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.elb_target_module.rst b/docs/community.aws.elb_target_module.rst index f596429753d..450e470048f 100644 --- a/docs/community.aws.elb_target_module.rst +++ b/docs/community.aws.elb_target_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -161,7 +162,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -177,7 +178,6 @@ 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
@@ -211,7 +211,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -371,7 +371,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -384,8 +384,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.execute_lambda_module.rst b/docs/community.aws.execute_lambda_module.rst index 4e9b5d6f4a2..5f6f70fd960 100644 --- a/docs/community.aws.execute_lambda_module.rst +++ b/docs/community.aws.execute_lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -161,7 +161,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,7 +223,6 @@ 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
@@ -257,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -298,7 +297,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -346,8 +345,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_cert_module.rst b/docs/community.aws.iam_cert_module.rst index 52d02622b65..7363b72fa27 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_cert_module.rst @@ -25,8 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- python >= 2.6 +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -52,7 +54,7 @@ Parameters -
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.
+
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
@@ -71,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +106,7 @@ Parameters -
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.
+
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
@@ -192,7 +194,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -287,7 +289,6 @@ 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
@@ -321,7 +322,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -364,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -376,8 +377,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_group_module.rst b/docs/community.aws.iam_group_module.rst index 2eb85c16334..90c97b2c894 100644 --- a/docs/community.aws.iam_group_module.rst +++ b/docs/community.aws.iam_group_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,7 +192,6 @@ 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
@@ -266,7 +264,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -324,7 +322,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -336,8 +334,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_managed_policy_module.rst b/docs/community.aws.iam_managed_policy_module.rst index 56ed8f76cd9..d5f9878f4a3 100644 --- a/docs/community.aws.iam_managed_policy_module.rst +++ b/docs/community.aws.iam_managed_policy_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -263,7 +262,6 @@ 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
@@ -297,7 +295,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -338,7 +336,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -350,8 +348,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_mfa_device_info_module.rst b/docs/community.aws.iam_mfa_device_info_module.rst index b76f802ef87..2d679b95a89 100644 --- a/docs/community.aws.iam_mfa_device_info_module.rst +++ b/docs/community.aws.iam_mfa_device_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -160,7 +159,6 @@ 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
@@ -194,7 +192,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -243,8 +241,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_module.rst b/docs/community.aws.iam_module.rst index be1e539d5d2..971d5afdcb3 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -14,6 +14,13 @@ Version added: 1.0.0 :local: :depth: 1 +DEPRECATED +---------- +:Removed in collection release after +:Why: The iam module is based upon a deprecated version of the AWS SDK. +:Alternative: Use :ref:`iam_user `, :ref:`iam_group `, :ref:`iam_role `, :ref:`iam_policy ` and :ref:`iam_managed_policy ` modules. + + Synopsis -------- @@ -25,8 +32,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -93,7 +102,7 @@ Parameters -
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.
+
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
@@ -112,7 +121,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -145,7 +154,7 @@ Parameters -
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.
+
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
@@ -182,7 +191,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -330,7 +339,6 @@ 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
@@ -364,7 +372,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -460,7 +468,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -473,8 +481,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -585,6 +594,10 @@ Status ------ +- This module will be removed in version 3.0.0. *[deprecated]* +- For more information see `DEPRECATED`_. + + Authors ~~~~~~~ diff --git a/docs/community.aws.iam_password_policy_module.rst b/docs/community.aws.iam_password_policy_module.rst index e1bdb8ce9fe..593be87d97f 100644 --- a/docs/community.aws.iam_password_policy_module.rst +++ b/docs/community.aws.iam_password_policy_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -74,7 +73,7 @@ Parameters -
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.
+
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
@@ -93,7 +92,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -126,7 +125,7 @@ Parameters -
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.
+
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
@@ -163,7 +162,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,7 +195,6 @@ 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
@@ -360,7 +358,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -402,7 +400,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -414,8 +412,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_policy_info_module.rst b/docs/community.aws.iam_policy_info_module.rst index 6d06db1d93f..1c3361febd1 100644 --- a/docs/community.aws.iam_policy_info_module.rst +++ b/docs/community.aws.iam_policy_info_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,7 +210,6 @@ 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
@@ -243,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -277,8 +277,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_policy_module.rst b/docs/community.aws.iam_policy_module.rst index f976ac1a4d0..e5fc98f019e 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -245,7 +246,6 @@ 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
@@ -279,7 +279,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -340,7 +340,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -352,8 +352,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_role_info_module.rst b/docs/community.aws.iam_role_info_module.rst index 2e3abc9fe1e..d7de4a0837d 100644 --- a/docs/community.aws.iam_role_info_module.rst +++ b/docs/community.aws.iam_role_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,7 +192,6 @@ 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
@@ -226,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -248,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -260,8 +259,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_role_module.rst b/docs/community.aws.iam_role_module.rst index e81541d815a..b2f8568bf43 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -70,7 +69,7 @@ Parameters -
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.
+
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
@@ -89,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +121,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,6 @@ Parameters
Boundaries cannot be set on Instance Profiles, as such if this option is specified then create_instance_profile must be false.
This is intended for roles/users that have permissions to create new IAM objects.
-
Requires botocore 1.10.57 or above.

aliases: boundary_policy_arn
@@ -233,7 +231,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -316,7 +314,6 @@ 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
@@ -390,7 +387,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -428,7 +425,6 @@ Parameters
Tag dict to apply to the queue.
-
Requires botocore 1.12.46 or above.
@@ -447,7 +443,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -459,8 +455,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_saml_federation_module.rst b/docs/community.aws.iam_saml_federation_module.rst index 3e9ac69b646..785b1509c4b 100644 --- a/docs/community.aws.iam_saml_federation_module.rst +++ b/docs/community.aws.iam_saml_federation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,7 +174,6 @@ 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
@@ -223,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -264,7 +263,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -276,8 +275,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_server_certificate_info_module.rst b/docs/community.aws.iam_server_certificate_info_module.rst index c41d2407cb4..1f81ea21f74 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -144,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -209,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -243,8 +241,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_user_info_module.rst b/docs/community.aws.iam_user_info_module.rst index f33064c0dd6..1ad22f8cc81 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,7 +205,6 @@ 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
@@ -240,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -262,7 +260,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -274,8 +272,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.iam_user_module.rst b/docs/community.aws.iam_user_module.rst index de70f8358d3..806451fa983 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,7 +192,6 @@ 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
@@ -247,7 +245,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -289,7 +287,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -301,8 +299,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.kinesis_stream_module.rst b/docs/community.aws.kinesis_stream_module.rst index 27b71b0b487..51ed5640cb0 100644 --- a/docs/community.aws.kinesis_stream_module.rst +++ b/docs/community.aws.kinesis_stream_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -231,7 +231,6 @@ 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
@@ -283,7 +282,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -356,7 +355,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -403,8 +402,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_alias_module.rst b/docs/community.aws.lambda_alias_module.rst index c50bf63db31..6d0acd53328 100644 --- a/docs/community.aws.lambda_alias_module.rst +++ b/docs/community.aws.lambda_alias_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -222,7 +222,6 @@ 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
@@ -256,7 +255,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -297,7 +296,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -309,8 +308,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_event_module.rst b/docs/community.aws.lambda_event_module.rst index 9d10ac318e9..14c0f6d008c 100644 --- a/docs/community.aws.lambda_event_module.rst +++ b/docs/community.aws.lambda_event_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,7 +212,6 @@ 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
@@ -246,7 +245,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -380,7 +379,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -408,8 +407,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_facts_module.rst b/docs/community.aws.lambda_facts_module.rst index 369bd9399be..417f3d17179 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -32,9 +32,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -60,7 +60,7 @@ Parameters -
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.
+
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
@@ -79,7 +79,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -112,7 +112,7 @@ Parameters -
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.
+
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
@@ -149,7 +149,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,7 +196,6 @@ 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
@@ -253,7 +252,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -275,7 +274,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -287,8 +286,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_info_module.rst b/docs/community.aws.lambda_info_module.rst index ce265e7087d..2f08ea7159b 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +190,6 @@ 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
@@ -247,7 +246,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -269,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -281,8 +280,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_module.rst b/docs/community.aws.lambda_module.rst index 7368c05fed4..682891507e9 100644 --- a/docs/community.aws.lambda_module.rst +++ b/docs/community.aws.lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -250,7 +250,6 @@ 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
@@ -366,7 +365,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -403,7 +402,7 @@ Parameters -
tag dict to apply to the function (requires botocore 1.5.40 or above).
+
Tag dict to apply to the function.
@@ -457,7 +456,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -521,8 +520,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lambda_policy_module.rst b/docs/community.aws.lambda_policy_module.rst index 6b9fdbf943b..ca1dd8a9309 100644 --- a/docs/community.aws.lambda_policy_module.rst +++ b/docs/community.aws.lambda_policy_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -86,7 +86,7 @@ Parameters -
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.
+
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
@@ -105,7 +105,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -138,7 +138,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,7 +243,6 @@ 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
@@ -277,7 +276,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +364,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -392,8 +391,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.lightsail_module.rst b/docs/community.aws.lightsail_module.rst index 5ff6b603b43..441529b5378 100644 --- a/docs/community.aws.lightsail_module.rst +++ b/docs/community.aws.lightsail_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,7 +223,6 @@ 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
@@ -257,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -318,7 +317,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -383,8 +382,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_instance_info_module.rst b/docs/community.aws.rds_instance_info_module.rst index 3e199320cb1..530ac744f26 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 -- python >= 2.7 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,7 +190,6 @@ 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
@@ -225,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +245,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -259,8 +257,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_instance_module.rst b/docs/community.aws.rds_instance_module.rst index e679974045b..2bb3a389893 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.5.0 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -142,7 +141,7 @@ Parameters -
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.
+
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
@@ -161,7 +160,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -194,7 +193,7 @@ Parameters -
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.
+
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
@@ -473,7 +472,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -928,7 +927,6 @@ 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
@@ -1136,7 +1134,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1403,7 +1401,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -1450,8 +1448,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_module.rst b/docs/community.aws.rds_module.rst index c3391656668..76da476f977 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -14,14 +14,20 @@ Version added: 1.0.0 :local: :depth: 1 +DEPRECATED +---------- +:Removed in collection release after +:Why: The rds module is based upon a deprecated version of the AWS SDK. +:Alternative: Use :ref:`rds_instance `, :ref:`rds_instance_info `, and :ref:`rds_snapshot `. + + Synopsis -------- - Creates, deletes, or modifies rds resources. - When creating an instance it can be either a new instance or a read-only replica of an existing instance. -- This module has a dependency on python-boto >= 2.5 and will soon be deprecated. - The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0). -- Please use boto3 based :ref:`community.aws.rds_instance ` instead. +- Please use the boto3 based :ref:`community.aws.rds_instance ` instead. @@ -29,8 +35,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- python >= 2.6 +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -76,7 +84,7 @@ Parameters -
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.
+
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
@@ -95,7 +103,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -128,7 +136,7 @@ Parameters -
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.
+
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
@@ -293,7 +301,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -542,7 +550,6 @@ 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
@@ -609,7 +616,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -751,7 +758,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -836,8 +843,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -1699,6 +1707,10 @@ Status ------ +- This module will be removed in version 3.0.0. *[deprecated]* +- For more information see `DEPRECATED`_. + + Authors ~~~~~~~ diff --git a/docs/community.aws.rds_param_group_module.rst b/docs/community.aws.rds_param_group_module.rst index 9905c5a88d8..9715206d56c 100644 --- a/docs/community.aws.rds_param_group_module.rst +++ b/docs/community.aws.rds_param_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,7 +243,6 @@ 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
@@ -296,7 +295,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -353,7 +352,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -365,8 +364,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_snapshot_info_module.rst b/docs/community.aws.rds_snapshot_info_module.rst index 8835ebf4347..7e5c169f9fe 100644 --- a/docs/community.aws.rds_snapshot_info_module.rst +++ b/docs/community.aws.rds_snapshot_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -209,7 +209,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -225,7 +225,6 @@ 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
@@ -259,7 +258,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -303,7 +302,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -315,8 +314,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_snapshot_module.rst b/docs/community.aws.rds_snapshot_module.rst index 95ec276a159..657b56b7165 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_snapshot_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,7 +191,6 @@ 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
@@ -244,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -300,7 +299,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -347,8 +346,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.rds_subnet_group_module.rst b/docs/community.aws.rds_subnet_group_module.rst index 3b624ccdb09..2618eb29a14 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,7 +190,6 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -294,8 +294,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.redshift_cross_region_snapshots_module.rst b/docs/community.aws.redshift_cross_region_snapshots_module.rst index f1ad74a43b6..10e633cb2e0 100644 --- a/docs/community.aws.redshift_cross_region_snapshots_module.rst +++ b/docs/community.aws.redshift_cross_region_snapshots_module.rst @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +54,7 @@ Parameters -
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.
+
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
@@ -74,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +106,7 @@ Parameters -
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.
+
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
@@ -178,7 +177,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,7 +193,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -304,7 +302,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -316,8 +314,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.redshift_info_module.rst b/docs/community.aws.redshift_info_module.rst index 4d8230f0ea6..6535817f66c 100644 --- a/docs/community.aws.redshift_info_module.rst +++ b/docs/community.aws.redshift_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +176,6 @@ 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
@@ -210,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -259,8 +258,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.redshift_module.rst b/docs/community.aws.redshift_module.rst index 27742aa8b82..c5bd313bacc 100644 --- a/docs/community.aws.redshift_module.rst +++ b/docs/community.aws.redshift_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -124,7 +124,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -157,7 +157,7 @@ Parameters -
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.
+
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
@@ -318,7 +318,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -531,7 +531,6 @@ 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
@@ -604,7 +603,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -680,7 +679,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -745,8 +744,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.redshift_subnet_group_module.rst b/docs/community.aws.redshift_subnet_group_module.rst index 7f66c0334a7..b007c1e9934 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -25,8 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- python >= 2.6 +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -52,7 +54,7 @@ Parameters -
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.
+
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
@@ -71,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +106,7 @@ Parameters -
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.
+
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
@@ -141,7 +143,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +160,7 @@ Parameters
Database subnet group description.
+
Required when state=present.

aliases: description
@@ -192,6 +195,7 @@ Parameters
List of subnet IDs that make up the cluster subnet group.
+
Required when state=present.

aliases: subnets
@@ -207,7 +211,6 @@ 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
@@ -241,7 +244,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +286,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -295,8 +298,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.route53_health_check_module.rst b/docs/community.aws.route53_health_check_module.rst index b4b25fada6b..3d29ebeb929 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -26,8 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- boto >= 2.49.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 +- python >= 3.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -230,7 +232,6 @@ 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
@@ -301,7 +302,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -380,7 +381,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -392,8 +393,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.route53_info_module.rst b/docs/community.aws.route53_info_module.rst index e44d3e25ed0..d81b24597e5 100644 --- a/docs/community.aws.route53_info_module.rst +++ b/docs/community.aws.route53_info_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -189,7 +190,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -313,7 +314,6 @@ 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
@@ -390,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -454,7 +454,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -466,8 +466,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.route53_module.rst b/docs/community.aws.route53_module.rst index 8c08e3bff64..47e58e06062 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -109,7 +108,7 @@ Parameters -
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.
+
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
@@ -128,7 +127,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -161,7 +160,7 @@ Parameters -
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.
+
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
@@ -198,7 +197,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -319,7 +318,6 @@ 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
@@ -385,7 +383,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -477,7 +475,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -589,8 +587,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.route53_zone_module.rst b/docs/community.aws.route53_zone_module.rst index 0af97d45d8f..f80f0e2a9ac 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -174,7 +174,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,7 +206,6 @@ 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
@@ -240,7 +239,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +280,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -339,8 +338,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.s3_bucket_notification_module.rst b/docs/community.aws.s3_bucket_notification_module.rst index a801b0ded68..0f62c6e343b 100644 --- a/docs/community.aws.s3_bucket_notification_module.rst +++ b/docs/community.aws.s3_bucket_notification_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -283,7 +283,6 @@ 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
@@ -317,7 +316,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -373,7 +372,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -386,8 +385,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.s3_lifecycle_module.rst b/docs/community.aws.s3_lifecycle_module.rst index 6382c26d25c..6a940862780 100644 --- a/docs/community.aws.s3_lifecycle_module.rst +++ b/docs/community.aws.s3_lifecycle_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -290,7 +291,6 @@ 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
@@ -380,7 +380,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -513,7 +513,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -547,8 +547,9 @@ Notes - 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.s3_logging_module.rst b/docs/community.aws.s3_logging_module.rst index cba4b51503d..67762810882 100644 --- a/docs/community.aws.s3_logging_module.rst +++ b/docs/community.aws.s3_logging_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -141,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,7 +174,6 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -279,7 +279,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -291,8 +291,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.s3_metrics_configuration_module.rst b/docs/community.aws.s3_metrics_configuration_module.rst index 570d88bd6f3..449fd5d9b1f 100644 --- a/docs/community.aws.s3_metrics_configuration_module.rst +++ b/docs/community.aws.s3_metrics_configuration_module.rst @@ -25,8 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.6 -- boto +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -52,7 +53,7 @@ Parameters -
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.
+
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
@@ -71,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -220,7 +221,6 @@ 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
@@ -254,7 +254,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +295,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -310,8 +310,9 @@ Notes - To request metrics for the entire bucket, create a metrics configuration without a filter - Metrics configurations are necessary only to enable request metric, bucket-level daily storage metrics are always turned on - If parameters 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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.s3_sync_module.rst b/docs/community.aws.s3_sync_module.rst index bc674a64e25..348639b2c2e 100644 --- a/docs/community.aws.s3_sync_module.rst +++ b/docs/community.aws.s3_sync_module.rst @@ -25,11 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 >= 1.4.4 -- botocore -- python >= 2.6 -- python-dateutil +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -195,7 +193,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -360,7 +358,6 @@ 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
@@ -409,7 +406,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -457,7 +454,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -469,8 +466,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -490,6 +488,11 @@ Examples file_root: roles/s3/files/ storage_class: GLACIER + - name: basic individual file upload + community.aws.s3_sync: + bucket: tedder + file_root: roles/s3/files/file_name + - name: all the options community.aws.s3_sync: bucket: tedder diff --git a/docs/community.aws.s3_website_module.rst b/docs/community.aws.s3_website_module.rst index 356cf0315ca..90078b3afc3 100644 --- a/docs/community.aws.s3_website_module.rst +++ b/docs/community.aws.s3_website_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,7 +189,6 @@ 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
@@ -238,7 +237,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -296,7 +295,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -308,8 +307,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.sns_module.rst b/docs/community.aws.sns_module.rst index 83d5165b902..177cf3c3452 100644 --- a/docs/community.aws.sns_module.rst +++ b/docs/community.aws.sns_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -69,7 +68,7 @@ Parameters -
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.
+
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
@@ -88,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +120,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -303,7 +302,6 @@ 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
@@ -337,7 +335,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -420,7 +418,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -432,8 +430,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.sns_topic_module.rst b/docs/community.aws.sns_topic_module.rst index 3cf7abcd32f..321a1b958ec 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -26,8 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -172,7 +173,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -219,7 +220,6 @@ 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
@@ -272,7 +272,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -349,6 +349,26 @@ Parameters + + +
+ topic_type + +
+ string +
+
added in 2.0.0
+ + +
    Choices: +
  • standard ←
    • +
  • fifo
    • +
+ + +
The type of topic that should be created. Either Standard for FIFO (first-in, first-out)
+ +
@@ -365,7 +385,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -377,8 +397,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.sqs_queue_module.rst b/docs/community.aws.sqs_queue_module.rst index 341f9ca2fc2..e32121739cb 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -287,7 +287,6 @@ 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
@@ -391,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -428,7 +427,7 @@ Parameters -
Tag dict to apply to the queue (requires botocore 1.5.40 or above).
+
Tag dict to apply to the queue.
To remove all tags set tags={} and purge_tags=true.
@@ -448,7 +447,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -476,8 +475,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.sts_assume_role_module.rst b/docs/community.aws.sts_assume_role_module.rst index 16b197c2bce..bfab5056a22 100644 --- a/docs/community.aws.sts_assume_role_module.rst +++ b/docs/community.aws.sts_assume_role_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -160,7 +159,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -236,7 +235,6 @@ 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
@@ -302,7 +300,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -324,7 +322,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -337,8 +335,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.sts_session_token_module.rst b/docs/community.aws.sts_session_token_module.rst index 26dae630d73..0a9b8e9c3a5 100644 --- a/docs/community.aws.sts_session_token_module.rst +++ b/docs/community.aws.sts_session_token_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,7 +203,6 @@ 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
@@ -238,7 +236,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -260,7 +258,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -273,8 +271,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_ip_set_info_module.rst b/docs/community.aws.wafv2_ip_set_info_module.rst index 204f6619644..4f654bf6060 100644 --- a/docs/community.aws.wafv2_ip_set_info_module.rst +++ b/docs/community.aws.wafv2_ip_set_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -251,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -263,8 +261,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_ip_set_module.rst b/docs/community.aws.wafv2_ip_set_module.rst index cd08ee1d1fd..506e1b2e1e2 100644 --- a/docs/community.aws.wafv2_ip_set_module.rst +++ b/docs/community.aws.wafv2_ip_set_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -176,7 +175,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -228,7 +227,6 @@ 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
@@ -301,7 +299,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -359,7 +357,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -371,8 +369,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_resources_info_module.rst b/docs/community.aws.wafv2_resources_info_module.rst index 3c11ea767b7..934e20ed66a 100644 --- a/docs/community.aws.wafv2_resources_info_module.rst +++ b/docs/community.aws.wafv2_resources_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -251,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -263,8 +261,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_resources_module.rst b/docs/community.aws.wafv2_resources_module.rst index 5cce8c74359..ab010c46476 100644 --- a/docs/community.aws.wafv2_resources_module.rst +++ b/docs/community.aws.wafv2_resources_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -70,7 +69,7 @@ Parameters -
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.
+
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
@@ -89,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +121,7 @@ Parameters -
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.
+
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
@@ -159,7 +158,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,7 +189,6 @@ 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
@@ -243,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -285,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -297,8 +295,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_rule_group_info_module.rst b/docs/community.aws.wafv2_rule_group_info_module.rst index 9de423f1e64..9af6fceb5db 100644 --- a/docs/community.aws.wafv2_rule_group_info_module.rst +++ b/docs/community.aws.wafv2_rule_group_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -271,7 +269,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -283,8 +281,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_rule_group_module.rst b/docs/community.aws.wafv2_rule_group_module.rst index a158cbb7946..36094e45332 100644 --- a/docs/community.aws.wafv2_rule_group_module.rst +++ b/docs/community.aws.wafv2_rule_group_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -192,7 +191,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -240,7 +239,6 @@ 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
@@ -348,7 +346,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -405,7 +403,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -417,8 +415,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_web_acl_info_module.rst b/docs/community.aws.wafv2_web_acl_info_module.rst index 0e1c329f840..761b4b9fd2c 100644 --- a/docs/community.aws.wafv2_web_acl_info_module.rst +++ b/docs/community.aws.wafv2_web_acl_info_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,7 +174,6 @@ 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
@@ -229,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -251,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -263,8 +261,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/docs/community.aws.wafv2_web_acl_module.rst b/docs/community.aws.wafv2_web_acl_module.rst index a23a519e438..32324dcd9b2 100644 --- a/docs/community.aws.wafv2_web_acl_module.rst +++ b/docs/community.aws.wafv2_web_acl_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto -- boto3 -- botocore -- python >= 2.6 +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Only used for boto3 based modules.
+
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -196,7 +195,7 @@ Parameters -
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -244,7 +243,6 @@ 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
@@ -433,7 +431,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -490,7 +488,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
@@ -502,8 +500,9 @@ 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_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 + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. diff --git a/galaxy.yml b/galaxy.yml index 92e1c2419b5..52f221bf07a 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 1.5.0 +version: 2.0.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.5.0' + amazon.aws: '>=2.0.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/meta/runtime.yml b/meta/runtime.yml index 7572647d422..c1ca9228a31 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -35,6 +35,7 @@ action_groups: - elb_target_group_facts - iam_mfa_device_facts - iam_role_facts + - iam_cert_facts - iam_server_certificate_facts - lambda_facts - rds_instance_facts @@ -171,6 +172,7 @@ action_groups: - iam_role - iam_role_info - iam_saml_federation + - iam_server_certificate - iam_server_certificate_info - iam_user - iam_user_info @@ -448,7 +450,7 @@ plugin_routing: deprecation: removal_date: 2021-12-01 warning_text: >- - iam_cert_facts was renamed in Ansible 2.9 to iam_cert_info. + iam_cert_facts was renamed in Ansible 2.9 to iam_server_certificate_info. Please update your tasks. iam_mfa_device_facts: deprecation: @@ -462,6 +464,13 @@ plugin_routing: warning_text: >- iam_role_facts was renamed in Ansible 2.9 to iam_role_info. Please update your tasks. + iam_cert: + redirect: community.aws.iam_server_certificate + deprecation: + removal_version: 4.0.0 + warning_text: >- + iam_cert has been renamed to iam_server_certificate for consistency. + Please update your tasks. iam_server_certificate_facts: deprecation: removal_date: 2021-12-01 diff --git a/plugins/modules/aws_msk_cluster.py b/plugins/modules/aws_msk_cluster.py index 41f2dd62e44..d6cf35d3ba3 100644 --- a/plugins/modules/aws_msk_cluster.py +++ b/plugins/modules/aws_msk_cluster.py @@ -544,7 +544,6 @@ def create_or_update_cluster(client, module): } }, "cluster_kafka_version": { - "botocore_version": "1.16.19", "current_value": cluster["CurrentBrokerSoftwareInfo"]["KafkaVersion"], "target_value": module.params.get("version"), "update_params": { diff --git a/plugins/modules/aws_msk_config.py b/plugins/modules/aws_msk_config.py index 6258ae916f6..f1966847422 100644 --- a/plugins/modules/aws_msk_config.py +++ b/plugins/modules/aws_msk_config.py @@ -279,9 +279,6 @@ def main(): module = AnsibleAWSModule(argument_spec=module_args, supports_check_mode=True) - # Support for update_configuration and delete_configuration added in 1.17.48 - module.require_botocore_at_least('1.17.48') - client = module.client("kafka", retry_decorator=AWSRetry.jittered_backoff()) if module.params["state"] == "present": diff --git a/plugins/modules/cloudfront_distribution.py b/plugins/modules/cloudfront_distribution.py index 9887a8d373a..80ac6dcec4b 100644 --- a/plugins/modules/cloudfront_distribution.py +++ b/plugins/modules/cloudfront_distribution.py @@ -1591,7 +1591,8 @@ def __init__(self, module): 'TLSv1_2016', 'TLSv1.1_2016', 'TLSv1.2_2018', - 'TLSv1.2_2019' + 'TLSv1.2_2019', + 'TLSv1.2_2021' ]) self.__valid_viewer_certificate_certificate_sources = set([ 'cloudfront', diff --git a/plugins/modules/dynamodb_table.py b/plugins/modules/dynamodb_table.py index b23c443cac9..7a3add3727a 100644 --- a/plugins/modules/dynamodb_table.py +++ b/plugins/modules/dynamodb_table.py @@ -19,8 +19,8 @@ requirements: - python >= 3.6 - boto >= 2.49.0 -- boto3 >= 1.13.0 -- botocore >= 1.16.0 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 options: state: description: diff --git a/plugins/modules/ec2_eip.py b/plugins/modules/ec2_eip.py index adf6f0bda41..927d31551b7 100644 --- a/plugins/modules/ec2_eip.py +++ b/plugins/modules/ec2_eip.py @@ -344,10 +344,11 @@ def address_is_associated_with_device(ec2, module, address, device_id, is_instan def allocate_address(ec2, module, domain, reuse_existing_ip_allowed, check_mode, tag_dict=None, public_ipv4_pool=None): """ Allocate a new elastic IP address (when needed) and return it """ + if not domain: + domain = 'standard' + if reuse_existing_ip_allowed: filters = [] - if not domain: - domain = 'standard' filters.append({'Name': 'domain', "Values": [domain]}) if tag_dict is not None: diff --git a/plugins/modules/elasticache_subnet_group.py b/plugins/modules/elasticache_subnet_group.py index 44a3e39ae6f..eda678205d0 100644 --- a/plugins/modules/elasticache_subnet_group.py +++ b/plugins/modules/elasticache_subnet_group.py @@ -12,34 +12,36 @@ version_added: 1.0.0 short_description: manage ElastiCache subnet groups description: - - Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. + - Creates, modifies, and deletes ElastiCache subnet groups. options: state: description: - Specifies whether the subnet should be present or absent. - required: true choices: [ 'present' , 'absent' ] + default: 'present' type: str name: description: - Database subnet group identifier. + - This value is automatically converted to lowercase. required: true type: str description: description: - - ElastiCache subnet group description. Only set when a new group is added. + - ElastiCache subnet group description. + - When not provided defaults to I(name) on subnet group creation. type: str subnets: description: - List of subnet IDs that make up the ElastiCache subnet group. + - At least one subnet must be provided when creating an ElastiCache subnet group. type: list elements: str -author: "Tim Mahoney (@timmahoney)" +author: + - "Tim Mahoney (@timmahoney)" extends_documentation_fragment: -- amazon.aws.aws -- amazon.aws.ec2 -requirements: -- boto >= 2.49.0 + - amazon.aws.aws + - amazon.aws.ec2 ''' EXAMPLES = r''' @@ -58,87 +60,195 @@ name: norwegian-blue ''' +RETURN = r''' +cache_subnet_group: + description: Description of the Elasticache Subnet Group. + returned: always + type: dict + contains: + arn: + description: The Amazon Resource Name (ARN) of the cache subnet group. + returned: when the subnet group exists + type: str + sample: arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue + description: + description: The description of the cache subnet group. + returned: when the cache subnet group exists + type: str + sample: My Fancy Ex Parrot Subnet Group + name: + description: The name of the cache subnet group. + returned: when the cache subnet group exists + type: str + sample: norwegian-blue + vpc_id: + description: The VPC ID of the cache subnet group. + returned: when the cache subnet group exists + type: str + sample: norwegian-blue + subnet_ids: + description: The IDs of the subnets beloging to the cache subnet group. + returned: when the cache subnet group exists + type: list + elements: str + sample: + - subnet-aaaaaaaa + - subnet-bbbbbbbb +''' + try: - import boto - from boto.elasticache import connect_to_region - from boto.exception import BotoServerError + import botocore except ImportError: - pass # Handled by HAS_BOTO + pass # Handled by AnsibleAWSModule + +from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict -from ansible.module_utils._text import to_native from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info +from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry + + +def get_subnet_group(name): + try: + groups = client.describe_cache_subnet_groups( + aws_retry=True, + CacheSubnetGroupName=name, + )['CacheSubnetGroups'] + except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): + return None + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except + module.fail_json_aws(e, msg="Failed to describe subnet group") + + if not groups: + return None + + if len(groups) > 1: + module.fail_aws( + msg="Found multiple matches for subnet group", + cache_subnet_groups=camel_dict_to_snake_dict(groups), + ) + + subnet_group = camel_dict_to_snake_dict(groups[0]) + + subnet_group['name'] = subnet_group['cache_subnet_group_name'] + subnet_group['description'] = subnet_group['cache_subnet_group_description'] + + subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) + subnet_group['subnet_ids'] = subnet_ids + + return subnet_group + + +def create_subnet_group(name, description, subnets): + + if not subnets: + module.fail_json(msg='At least one subnet must be provided when creating a subnet group') + + if module.check_mode: + return True + + try: + if not description: + description = name + client.create_cache_subnet_group( + aws_retry=True, + CacheSubnetGroupName=name, + CacheSubnetGroupDescription=description, + SubnetIds=subnets, + ) + return True + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: + module.fail_json_aws(e, msg="Failed to create subnet group") + + +def update_subnet_group(subnet_group, name, description, subnets): + update_params = dict() + if description and subnet_group['description'] != description: + update_params['CacheSubnetGroupDescription'] = description + if subnets: + old_subnets = set(subnet_group['subnet_ids']) + new_subnets = set(subnets) + if old_subnets != new_subnets: + update_params['SubnetIds'] = list(subnets) + + if not update_params: + return False + + if module.check_mode: + return True + + try: + client.modify_cache_subnet_group( + aws_retry=True, + CacheSubnetGroupName=name, + **update_params, + ) + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: + module.fail_json_aws(e, msg="Failed to update subnet group") + + return True + + +def delete_subnet_group(name): + + if module.check_mode: + return True + + try: + client.delete_cache_subnet_group( + aws_retry=True, + CacheSubnetGroupName=name, + ) + return True + except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): + # AWS is "eventually consistent", cope with the race conditions where + # deletion hadn't completed when we ran describe + return False + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except + module.fail_json_aws(e, msg="Failed to delete subnet group") def main(): argument_spec = dict( - state=dict(required=True, choices=['present', 'absent']), + state=dict(default='present', choices=['present', 'absent']), name=dict(required=True), description=dict(required=False), subnets=dict(required=False, type='list', elements='str'), ) - module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - if not HAS_BOTO: - module.fail_json(msg='boto required for this module') - - state = module.params.get('state') - group_name = module.params.get('name').lower() - group_description = module.params.get('description') - group_subnets = module.params.get('subnets') or {} + global module + global client - if state == 'present': - for required in ['name', 'description', 'subnets']: - if not module.params.get(required): - module.fail_json(msg=str("Parameter %s required for state='present'" % required)) - else: - for not_allowed in ['description', 'subnets']: - if module.params.get(not_allowed): - module.fail_json(msg=str("Parameter %s not allowed for state='absent'" % not_allowed)) + module = AnsibleAWSModule( + argument_spec=argument_spec, + supports_check_mode=True, + ) - # Retrieve any AWS settings from the environment. - region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module) + state = module.params.get('state') + name = module.params.get('name').lower() + description = module.params.get('description') + subnets = module.params.get('subnets') - if not region: - module.fail_json(msg=str("Either region or AWS_REGION or EC2_REGION environment variable or boto config aws_region or ec2_region must be set.")) + client = module.client('elasticache', retry_decorator=AWSRetry.jittered_backoff()) - """Get an elasticache connection""" - try: - conn = connect_to_region(region_name=region, **aws_connect_kwargs) - except boto.exception.NoAuthHandlerFound as e: - module.fail_json(msg=to_native(e)) + subnet_group = get_subnet_group(name) + changed = False - try: - changed = False - exists = False - - try: - matching_groups = conn.describe_cache_subnet_groups(group_name, max_records=100) - exists = len(matching_groups) > 0 - except BotoServerError as e: - if e.error_code != 'CacheSubnetGroupNotFoundFault': - module.fail_json(msg=e.error_message) - - if state == 'absent': - if exists: - conn.delete_cache_subnet_group(group_name) - changed = True - else: - if not exists: - new_group = conn.create_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) - changed = True - else: - changed_group = conn.modify_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) - changed = True - - except BotoServerError as e: - if e.error_message != 'No modifications were requested.': - module.fail_json(msg=e.error_message) + if state == 'present': + if not subnet_group: + result = create_subnet_group(name, description, subnets) + changed |= result else: - changed = False + result = update_subnet_group(subnet_group, name, description, subnets) + changed |= result + subnet_group = get_subnet_group(name) + else: + if subnet_group: + result = delete_subnet_group(name) + changed |= result + subnet_group = None - module.exit_json(changed=changed) + module.exit_json(changed=changed, cache_subnet_group=subnet_group) if __name__ == '__main__': diff --git a/plugins/modules/elb_target_group.py b/plugins/modules/elb_target_group.py index 45649e7e651..9a740422293 100644 --- a/plugins/modules/elb_target_group.py +++ b/plugins/modules/elb_target_group.py @@ -161,6 +161,23 @@ - The identifier of the virtual private cloud (VPC). Required when I(state) is C(present). required: false type: str + preserve_client_ip_enabled: + description: + - Indicates whether client IP preservation is enabled. + - The default is disabled if the target group type is C(ip) address and the target group protocol is C(tcp) or C(tls). + Otherwise, the default is enabled. Client IP preservation cannot be disabled for C(udp) and C(tcp_udp) target groups. + - I(preserve_client_ip_enabled) is supported only by Network Load Balancers. + type: bool + required: false + version_added: 2.1.0 + proxy_protocol_v2_enabled: + description: + - Indicates whether Proxy Protocol version 2 is enabled. + - The value is C(true) or C(false). + - I(proxy_protocol_v2_enabled) is supported only by Network Load Balancers. + type: bool + required: false + version_added: 2.1.0 wait: description: - Whether or not to wait for the target group. @@ -474,6 +491,8 @@ def create_or_update_target_group(connection, module): stickiness_type = module.params.get("stickiness_type") stickiness_app_cookie_duration = module.params.get("stickiness_app_cookie_duration") stickiness_app_cookie_name = module.params.get("stickiness_app_cookie_name") + preserve_client_ip_enabled = module.params.get("preserve_client_ip_enabled") + proxy_protocol_v2_enabled = module.params.get("proxy_protocol_v2_enabled") health_option_keys = [ "health_check_path", "health_check_protocol", "health_check_interval", "health_check_timeout", @@ -763,6 +782,13 @@ def create_or_update_target_group(connection, module): if stickiness_app_cookie_duration is not None: if str(stickiness_app_cookie_duration) != current_tg_attributes['stickiness_app_cookie_duration_seconds']: update_attributes.append({'Key': 'stickiness.app_cookie.duration_seconds', 'Value': str(stickiness_app_cookie_duration)}) + if preserve_client_ip_enabled is not None: + if target_type not in ('udp', 'tcp_udp'): + if str(preserve_client_ip_enabled).lower() != current_tg_attributes.get('preserve_client_ip_enabled'): + update_attributes.append({'Key': 'preserve_client_ip.enabled', 'Value': str(preserve_client_ip_enabled).lower()}) + if proxy_protocol_v2_enabled is not None: + if str(proxy_protocol_v2_enabled).lower() != current_tg_attributes.get('proxy_protocol_v2_enabled'): + update_attributes.append({'Key': 'proxy_protocol_v2.enabled', 'Value': str(proxy_protocol_v2_enabled).lower()}) if update_attributes: try: @@ -852,6 +878,8 @@ def main(): targets=dict(type='list', elements='dict'), unhealthy_threshold_count=dict(type='int'), vpc_id=dict(), + preserve_client_ip_enabled=dict(type='bool'), + proxy_protocol_v2_enabled=dict(type='bool'), wait_timeout=dict(type='int', default=200), wait=dict(type='bool', default=False) ) diff --git a/plugins/modules/iam_cert.py b/plugins/modules/iam_server_certificate.py similarity index 88% rename from plugins/modules/iam_cert.py rename to plugins/modules/iam_server_certificate.py index fbe984670aa..5402b22d126 100644 --- a/plugins/modules/iam_cert.py +++ b/plugins/modules/iam_server_certificate.py @@ -20,7 +20,7 @@ DOCUMENTATION = ''' --- -module: iam_cert +module: iam_server_certificate version_added: 1.0.0 short_description: Manage server certificates for use on ELBs and CloudFront description: @@ -56,17 +56,23 @@ cert_chain: description: - The path to, or content of, the CA certificate chain in PEM encoded format. - As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. + - If the parameter is not a file, it is assumed to be content. + - Passing a file name is deprecated, and support will be dropped in + version 4.0.0 of this collection. type: str cert: description: - The path to, or content of the certificate body in PEM encoded format. - As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. + - If the parameter is not a file, it is assumed to be content. + - Passing a file name is deprecated, and support will be dropped in + version 4.0.0 of this collection. type: str key: description: - The path to, or content of the private key in PEM encoded format. - As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. + If the parameter is not a file, it is assumed to be content. + - Passing a file name is deprecated, and support will be dropped in + version 4.0.0 of this collection. type: str dup_ok: description: @@ -85,7 +91,7 @@ EXAMPLES = ''' - name: Basic server certificate upload from local file - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present cert: "{{ lookup('file', 'path/to/cert') }}" @@ -93,7 +99,7 @@ cert_chain: "{{ lookup('file', 'path/to/certchain') }}" - name: Basic server certificate upload - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present cert: path/to/cert @@ -101,7 +107,7 @@ cert_chain: path/to/certchain - name: Server certificate upload using key string - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present path: "/a/cert/path/" @@ -110,7 +116,7 @@ cert_chain: body_of_myverytrustedchain - name: Basic rename of existing certificate - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl new_name: new_very_ssl state: present @@ -231,16 +237,31 @@ def load_data(cert, key, cert_chain): if cert and os.path.isfile(cert): with open(cert, 'r') as cert_fh: cert = cert_fh.read().rstrip() + module.deprecate( + 'Passing a file name as the cert argument has been deprecated. ' + 'Please use a lookup instead, see the documentation for examples.', + version='4.0.0', collection_name='community.aws') if key and os.path.isfile(key): with open(key, 'r') as key_fh: key = key_fh.read().rstrip() + module.deprecate( + 'Passing a file name as the key argument has been deprecated. ' + 'Please use a lookup instead, see the documentation for examples.', + version='4.0.0', collection_name='community.aws') if cert_chain and os.path.isfile(cert_chain): with open(cert_chain, 'r') as cert_chain_fh: cert_chain = cert_chain_fh.read() + module.deprecate( + 'Passing a file name as the cert_chain argument has been deprecated. ' + 'Please use a lookup instead, see the documentation for examples.', + version='4.0.0', collection_name='community.aws') return cert, key, cert_chain def main(): + + global module + argument_spec = dict( state=dict(required=True, choices=['present', 'absent']), name=dict(required=True), diff --git a/plugins/modules/rds_instance_info.py b/plugins/modules/rds_instance_info.py index fba7804012a..13609972c17 100644 --- a/plugins/modules/rds_instance_info.py +++ b/plugins/modules/rds_instance_info.py @@ -234,6 +234,11 @@ returned: always type: str sample: '2017-10-10T04:00:07.434000+00:00' + iops: + description: The Provisioned IOPS value for the DB instance. + returned: always + type: int + sample: 1000 kms_key_id: description: KMS Key ID returned: always diff --git a/plugins/modules/redshift_subnet_group.py b/plugins/modules/redshift_subnet_group.py index fa210a5bee4..89e8bfa8042 100644 --- a/plugins/modules/redshift_subnet_group.py +++ b/plugins/modules/redshift_subnet_group.py @@ -9,8 +9,6 @@ DOCUMENTATION = r''' --- -author: - - "Jens Carl (@j-carl), Hothead Games Inc." module: redshift_subnet_group version_added: 1.0.0 short_description: manage Redshift cluster subnet groups @@ -19,32 +17,33 @@ options: state: description: - - Specifies whether the subnet should be present or absent. - required: true + - Specifies whether the subnet group should be present or absent. + default: 'present' choices: ['present', 'absent' ] type: str - group_name: + name: description: - Cluster subnet group name. required: true - aliases: ['name'] + aliases: ['group_name'] type: str - group_description: + description: description: - - Database subnet group description. - aliases: ['description'] + - Cluster subnet group description. + aliases: ['group_description'] type: str - group_subnets: + subnets: description: - List of subnet IDs that make up the cluster subnet group. - aliases: ['subnets'] + - At least one subnet must be provided when creating a cluster subnet group. + aliases: ['group_subnets'] type: list elements: str extends_documentation_fragment: - amazon.aws.aws - amazon.aws.ec2 -requirements: -- boto >= 2.49.0 +author: + - "Jens Carl (@j-carl), Hothead Games Inc." ''' EXAMPLES = r''' @@ -64,113 +63,209 @@ ''' RETURN = r''' -group: - description: dictionary containing all Redshift subnet group information +cluster_subnet_group: + description: A dictionary containing information about the Redshift subnet group. returned: success - type: complex + type: dict contains: name: - description: name of the Redshift subnet group - returned: success + description: Name of the Redshift subnet group. + returned: when the cache subnet group exists type: str sample: "redshift_subnet_group_name" vpc_id: - description: Id of the VPC where the subnet is located - returned: success + description: Id of the VPC where the subnet is located. + returned: when the cache subnet group exists type: str sample: "vpc-aabb1122" + description: + description: The description of the cache subnet group. + returned: when the cache subnet group exists + type: str + sample: Redshift subnet + subnet_ids: + description: The IDs of the subnets beloging to the Redshift subnet group. + returned: when the cache subnet group exists + type: list + elements: str + sample: + - subnet-aaaaaaaa + - subnet-bbbbbbbb ''' try: - import boto - import boto.redshift + import botocore except ImportError: - pass # Handled by HAS_BOTO + pass # Handled by AnsibleAWSModule + +from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import connect_to_aws -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info +from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict + + +def get_subnet_group(name): + try: + groups = client.describe_cluster_subnet_groups( + aws_retry=True, + ClusterSubnetGroupName=name, + )['ClusterSubnetGroups'] + except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): + return None + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except + module.fail_json_aws(e, msg="Failed to describe subnet group") + + if not groups: + return None + + if len(groups) > 1: + module.fail_aws( + msg="Found multiple matches for subnet group", + cluster_subnet_groups=camel_dict_to_snake_dict(groups), + ) + + # No support for managing tags yet, but make sure that we don't need to + # change the return value structure after it's been available in a release. + tags = boto3_tag_list_to_ansible_dict(groups[0]['Tags']) + + subnet_group = camel_dict_to_snake_dict(groups[0]) + + subnet_group['tags'] = tags + subnet_group['name'] = subnet_group['cluster_subnet_group_name'] + + subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) + subnet_group['subnet_ids'] = subnet_ids + + return subnet_group + + +def create_subnet_group(name, description, subnets): + + if not subnets: + module.fail_json(msg='At least one subnet must be provided when creating a subnet group') + + if module.check_mode: + return True + + try: + if not description: + description = name + client.create_cluster_subnet_group( + aws_retry=True, + ClusterSubnetGroupName=name, + Description=description, + SubnetIds=subnets, + ) + return True + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: + module.fail_json_aws(e, msg="Failed to create subnet group") + + +def update_subnet_group(subnet_group, name, description, subnets): + update_params = dict() + if description and subnet_group['description'] != description: + update_params['Description'] = description + if subnets: + old_subnets = set(subnet_group['subnet_ids']) + new_subnets = set(subnets) + if old_subnets != new_subnets: + update_params['SubnetIds'] = list(subnets) + + if not update_params: + return False + + if module.check_mode: + return True + + # Description is optional, SubnetIds is not + if 'SubnetIds' not in update_params: + update_params['SubnetIds'] = subnet_group['subnet_ids'] + + try: + client.modify_cluster_subnet_group( + aws_retry=True, + ClusterSubnetGroupName=name, + **update_params, + ) + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: + module.fail_json_aws(e, msg="Failed to update subnet group") + + return True + + +def delete_subnet_group(name): + + if module.check_mode: + return True + + try: + client.delete_cluster_subnet_group( + aws_retry=True, + ClusterSubnetGroupName=name, + ) + return True + except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): + # AWS is "eventually consistent", cope with the race conditions where + # deletion hadn't completed when we ran describe + return False + except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except + module.fail_json_aws(e, msg="Failed to delete subnet group") def main(): argument_spec = dict( - state=dict(required=True, choices=['present', 'absent']), - group_name=dict(required=True, aliases=['name']), - group_description=dict(required=False, aliases=['description']), - group_subnets=dict(required=False, aliases=['subnets'], type='list', elements='str'), + state=dict(default='present', choices=['present', 'absent']), + name=dict(required=True, aliases=['group_name']), + description=dict(required=False, aliases=['group_description']), + subnets=dict(required=False, aliases=['group_subnets'], type='list', elements='str'), ) - module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - if not HAS_BOTO: - module.fail_json(msg='boto v2.9.0+ required for this module') + global module + global client + + module = AnsibleAWSModule( + argument_spec=argument_spec, + supports_check_mode=True, + ) state = module.params.get('state') - group_name = module.params.get('group_name') - group_description = module.params.get('group_description') - group_subnets = module.params.get('group_subnets') + name = module.params.get('name') + description = module.params.get('description') + subnets = module.params.get('subnets') - if state == 'present': - for required in ('group_name', 'group_description', 'group_subnets'): - if not module.params.get(required): - module.fail_json(msg=str("parameter %s required for state='present'" % required)) - else: - for not_allowed in ('group_description', 'group_subnets'): - if module.params.get(not_allowed): - module.fail_json(msg=str("parameter %s not allowed for state='absent'" % not_allowed)) + client = module.client('redshift', retry_decorator=AWSRetry.jittered_backoff()) - region, ec2_url, aws_connect_params = get_aws_connection_info(module) - if not region: - module.fail_json(msg=str("Region must be specified as a parameter, in EC2_REGION or AWS_REGION environment variables or in boto configuration file")) + subnet_group = get_subnet_group(name) + changed = False - # Connect to the Redshift endpoint. - try: - conn = connect_to_aws(boto.redshift, region, **aws_connect_params) - except boto.exception.JSONResponseError as e: - module.fail_json(msg=str(e)) + if state == 'present': + if not subnet_group: + result = create_subnet_group(name, description, subnets) + changed |= result + else: + result = update_subnet_group(subnet_group, name, description, subnets) + changed |= result + subnet_group = get_subnet_group(name) + else: + if subnet_group: + result = delete_subnet_group(name) + changed |= result + subnet_group = None - try: - changed = False - exists = False - group = None - - try: - matching_groups = conn.describe_cluster_subnet_groups(group_name, max_records=100) - exists = len(matching_groups) > 0 - except boto.exception.JSONResponseError as e: - if e.body['Error']['Code'] != 'ClusterSubnetGroupNotFoundFault': - # if e.code != 'ClusterSubnetGroupNotFoundFault': - module.fail_json(msg=str(e)) - - if state == 'absent': - if exists: - conn.delete_cluster_subnet_group(group_name) - changed = True + compat_results = dict() + if subnet_group: + compat_results['group'] = dict( + name=subnet_group['name'], + vpc_id=subnet_group['vpc_id'], + ) - else: - if not exists: - new_group = conn.create_cluster_subnet_group(group_name, group_description, group_subnets) - group = { - 'name': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] - ['ClusterSubnetGroup']['ClusterSubnetGroupName'], - 'vpc_id': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] - ['ClusterSubnetGroup']['VpcId'], - } - else: - changed_group = conn.modify_cluster_subnet_group(group_name, group_subnets, description=group_description) - group = { - 'name': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] - ['ClusterSubnetGroup']['ClusterSubnetGroupName'], - 'vpc_id': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] - ['ClusterSubnetGroup']['VpcId'], - } - - changed = True - - except boto.exception.JSONResponseError as e: - module.fail_json(msg=str(e)) - - module.exit_json(changed=changed, group=group) + module.exit_json( + changed=changed, + cluster_subnet_group=subnet_group, + **compat_results, + ) if __name__ == '__main__': diff --git a/plugins/modules/route53.py b/plugins/modules/route53.py index d1391cfac58..d4fe99531c0 100644 --- a/plugins/modules/route53.py +++ b/plugins/modules/route53.py @@ -606,6 +606,7 @@ def main(): 'TTL': ttl_in, 'ResourceRecords': [dict(Value=value) for value in value_in], 'HealthCheckId': health_check_in, + 'SetIdentifier': identifier_in, }) if alias_in: diff --git a/plugins/modules/sns_topic.py b/plugins/modules/sns_topic.py index dd5af417bab..37cf573ce58 100644 --- a/plugins/modules/sns_topic.py +++ b/plugins/modules/sns_topic.py @@ -49,6 +49,73 @@ description: - Delivery policy to apply to the SNS topic. type: dict + suboptions: + http: + description: + - Delivery policy for HTTP(S) messages. + - See U(https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) + for more information. + type: dict + required: false + suboptions: + disableSubscriptionOverrides: + description: + - Applies this policy to all subscriptions, even if they have their own policies. + type: bool + required: false + defaultThrottlePolicy: + description: + - Throttle the rate of messages sent to subsriptions. + type: dict + suboptions: + maxReceivesPerSecond: + description: + - The maximum number of deliveries per second per subscription. + type: int + required: true + required: false + defaultHealthyRetryPolicy: + description: + - Retry policy for HTTP(S) messages. + type: dict + required: true + suboptions: + minDelayTarget: + description: + - The minimum delay for a retry. + type: int + required: true + maxDelayTarget: + description: + - The maximum delay for a retry. + type: int + required: true + numRetries: + description: + - The total number of retries. + type: int + required: true + numMaxDelayRetries: + description: + - The number of retries with the maximum delay between them. + type: int + required: true + numMinDelayRetries: + description: + - The number of retries with just the minimum delay between them. + type: int + required: true + numNoDelayRetries: + description: + - The number of retries to be performmed immediately. + type: int + required: true + backoffFunction: + description: + - The function for backoff between retries. + type: str + required: true + choices: ['arithmetic', 'exponential', 'geometric', 'linear'] subscriptions: description: - List of subscriptions to apply to the topic. Note that AWS requires @@ -225,8 +292,12 @@ except ImportError: pass # handled by AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule, is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies, AWSRetry, camel_dict_to_snake_dict +from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule +from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code +from ansible_collections.amazon.aws.plugins.module_utils.core import scrub_none_parameters +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import camel_dict_to_snake_dict class SnsTopicManager(object): @@ -251,7 +322,7 @@ def __init__(self, self.state = state self.display_name = display_name self.policy = policy - self.delivery_policy = delivery_policy + self.delivery_policy = scrub_none_parameters(delivery_policy) if delivery_policy else None self.subscriptions = subscriptions self.subscriptions_existing = [] self.subscriptions_deleted = [] @@ -495,13 +566,39 @@ def get_info(self): def main(): + + # We're kinda stuck with CamelCase here, it would be nice to switch to + # snake_case, but we'd need to purge out the alias entries + http_retry_args = dict( + minDelayTarget=dict(type='int', required=True), + maxDelayTarget=dict(type='int', required=True), + numRetries=dict(type='int', required=True), + numMaxDelayRetries=dict(type='int', required=True), + numMinDelayRetries=dict(type='int', required=True), + numNoDelayRetries=dict(type='int', required=True), + backoffFunction=dict(type='str', required=True, choices=['arithmetic', 'exponential', 'geometric', 'linear']), + ) + http_delivery_args = dict( + defaultHealthyRetryPolicy=dict(type='dict', required=True, options=http_retry_args), + disableSubscriptionOverrides=dict(type='bool', required=False), + defaultThrottlePolicy=dict( + type='dict', required=False, + options=dict( + maxReceivesPerSecond=dict(type='int', required=True), + ), + ), + ) + delivery_args = dict( + http=dict(type='dict', required=False, options=http_delivery_args), + ) + argument_spec = dict( name=dict(required=True), topic_type=dict(type='str', default='standard', choices=['standard', 'fifo']), state=dict(default='present', choices=['present', 'absent']), display_name=dict(), policy=dict(type='dict'), - delivery_policy=dict(type='dict'), + delivery_policy=dict(type='dict', options=delivery_args), subscriptions=dict(default=[], type='list', elements='dict'), purge_subscriptions=dict(type='bool', default=True), ) diff --git a/requirements.txt b/requirements.txt index 0d58b96112d..3685e404330 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,8 @@ +# When updating the minimal requirements please also update +# - tests/unit/constraints.txt +# - tests/integration/constraints.txt +# - tests/integration/targets/setup_botocore_pip +botocore>=1.18.0 +boto3>=1.15.0 +# Final released version boto>=2.49.0 -botocore>=1.16.0 -boto3>=1.13.0 diff --git a/test-requirements.txt b/test-requirements.txt index 3d217284154..77c76b86509 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,7 @@ +botocore +boto3 +boto + coverage==4.5.4 placebo mock @@ -8,3 +12,5 @@ pytest-mock netaddr # Sometimes needed where we don't have features we need in modules awscli +# Used for comparing SSH Public keys to the Amazon fingerprints +pycrypto diff --git a/tests/config.yml b/tests/config.yml new file mode 100644 index 00000000000..5112f726881 --- /dev/null +++ b/tests/config.yml @@ -0,0 +1,2 @@ +modules: + python_requires: '>=3.6' diff --git a/tests/integration/constraints.txt b/tests/integration/constraints.txt index c105f290280..bd95eb26733 100644 --- a/tests/integration/constraints.txt +++ b/tests/integration/constraints.txt @@ -1,3 +1,7 @@ -boto3 >= 1.9.250, <= 1.15.18 # minimum version that supports botocore 1.13.3, max that will work with ansible 2.9's other constraints -botocore<1.19.0,>=1.13.3 # adds support for ECR image scanning +# Specifically run tests against the oldest versions that we support +boto3==1.15.0 +botocore==1.18.0 +# AWS CLI has `botocore==` dependencies, provide the one that matches botocore +# to avoid needing to download over a years worth of awscli wheels. +awscli==1.18.141 diff --git a/tests/integration/requirements.txt b/tests/integration/requirements.txt index 2fb8f547d8a..6e870975a35 100644 --- a/tests/integration/requirements.txt +++ b/tests/integration/requirements.txt @@ -1,5 +1,12 @@ +# Our code is based on the AWS SDKs +boto +boto3 +botocore + # netaddr is needed for ansible.netcommon.ipv6 netaddr virtualenv -boto3 -botocore +# Sometimes needed where we don't have features we need in modules +awscli +# Used for comparing SSH Public keys to the Amazon fingerprints +pycrypto diff --git a/tests/integration/targets/aws_msk_cluster/tasks/main.yml b/tests/integration/targets/aws_msk_cluster/tasks/main.yml index 9ace1814f81..a3049dad0b4 100644 --- a/tests/integration/targets/aws_msk_cluster/tasks/main.yml +++ b/tests/integration/targets/aws_msk_cluster/tasks/main.yml @@ -40,60 +40,38 @@ - set_fact: subnet_ids: '{{ subnets | community.general.json_query("results[].subnet.id") | list }}' - - pip: - name: virtualenv - - set_fact: - virtualenv: "{{ remote_tmp_dir }}/virtualenv" - virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" - - set_fact: - virtualenv_interpreter: "{{ virtualenv }}/bin/python" - - pip: - name: - - 'boto3>=1.13.0' - - 'botocore==1.17.48' - - 'coverage<5' - virtualenv: '{{ virtualenv }}' - virtualenv_command: '{{ virtualenv_command }}' - virtualenv_site_packages: no - # ============================================================ - - name: Wrap test in virtualenv - vars: - ansible_python_interpreter: "{{ virtualenv }}/bin/python" - block: - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: - - "{{ msk_version }}" - register: msk_config + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: + - "{{ msk_version }}" + register: msk_config - - name: create tests - include_tasks: test_create.yml + - name: create tests + include_tasks: test_create.yml - - name: update tests - include_tasks: test_update.yml + - name: update tests + include_tasks: test_update.yml - - name: delete tests - include_tasks: test_delete.yml + - name: delete tests + include_tasks: test_delete.yml - always: - - - name: delete msk cluster - aws_msk_cluster: - name: "{{ msk_cluster_name }}" - state: absent - wait: true - ignore_errors: yes + always: - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + - name: delete msk cluster + aws_msk_cluster: + name: "{{ msk_cluster_name }}" + state: absent + wait: true + ignore_errors: yes - always: + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes - name: remove subnets ec2_vpc_subnet: diff --git a/tests/integration/targets/aws_msk_config/tasks/main.yml b/tests/integration/targets/aws_msk_config/tasks/main.yml index d29631c1930..cef9e1dfc90 100644 --- a/tests/integration/targets/aws_msk_config/tasks/main.yml +++ b/tests/integration/targets/aws_msk_config/tasks/main.yml @@ -9,161 +9,140 @@ collections: - amazon.aws block: - - - pip: - name: virtualenv - - set_fact: - virtualenv: "{{ remote_tmp_dir }}/virtualenv" - virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" - - set_fact: - virtualenv_interpreter: "{{ virtualenv }}/bin/python" - - pip: - name: - - 'boto3>=1.13.0' - - 'botocore==1.17.48' - - 'coverage<5' - virtualenv: '{{ virtualenv }}' - virtualenv_command: '{{ virtualenv_command }}' - virtualenv_site_packages: no - - - name: Wrap test in virtualenv - vars: - ansible_python_interpreter: "{{ virtualenv }}/bin/python" - block: - - name: create msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be created - assert: - that: - - msk_config is changed - - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration is created - assert: - that: - - msk_config is changed - - - name: create msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: validate return values - assert: - that: - - msk_config.revision == 1 - - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" - - "'auto.create.topics.enable=True' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" - - - name: update msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: update msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: validate return values (update) - assert: - that: - - msk_config.revision == 2 - - "'auto.create.topics.enable=True' not in msk_config.server_properties" - - "'num.io.threads=8' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" - - - name: update msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: delete msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - always: - - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + - name: create msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be created + assert: + that: + - msk_config is changed + + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration is created + assert: + that: + - msk_config is changed + + - name: create msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: validate return values + assert: + that: + - msk_config.revision == 1 + - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" + - "'auto.create.topics.enable=True' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" + + - name: update msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: update msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: validate return values (update) + assert: + that: + - msk_config.revision == 2 + - "'auto.create.topics.enable=True' not in msk_config.server_properties" + - "'num.io.threads=8' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" + + - name: update msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: delete msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + always: + + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes diff --git a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml index 8dd14bfbd42..77c193043a9 100644 --- a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml +++ b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml @@ -10,7 +10,7 @@ virtualenv_interpreter: "{{ virtualenv }}/bin/python" - pip: name: - - 'boto3>=1.13.0' + - 'boto3>=1.15.0' - 'botocore==1.18.11' - 'coverage<5' virtualenv: '{{ virtualenv }}' diff --git a/tests/integration/targets/dynamodb_table/aliases b/tests/integration/targets/dynamodb_table/aliases new file mode 100644 index 00000000000..4ef4b2067d0 --- /dev/null +++ b/tests/integration/targets/dynamodb_table/aliases @@ -0,0 +1 @@ +cloud/aws diff --git a/tests/integration/targets/dynamodb_table/defaults/main.yml b/tests/integration/targets/dynamodb_table/defaults/main.yml new file mode 100644 index 00000000000..47fc4243153 --- /dev/null +++ b/tests/integration/targets/dynamodb_table/defaults/main.yml @@ -0,0 +1,47 @@ +--- +table_name: '{{ resource_prefix }}' + +table_index: 'id' +table_index_type: 'NUMBER' + +range_index: 'variety' +range_index_type: 'STRING' + +indexes: + - name: NamedIndex + type: global_include + hash_key_name: idx + range_key_name: create_time + includes: + - other_field + - other_field2 + read_capacity: 10 + write_capacity: 10 + - name: AnotherIndex + type: global_all + hash_key_name: foo + range_key_name: bar + includes: + - another_field + - another_field2 + read_capacity: 5 + write_capacity: 5 + + +tags_default: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + PascalCaseKey: PascalCaseValue + 'key with spaces': value with spaces + 'Upper With Spaces': Upper With Spaces + +partial_tags: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + +updated_tags: + updated_snake_case_key: updated_snake_case_value + updatedCamelCaseKey: updatedCamelCaseValue + UpdatedPascalCaseKey: UpdatedPascalCaseValue + 'updated key with spaces': updated value with spaces + 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/dynamodb_table/meta/main.yml b/tests/integration/targets/dynamodb_table/meta/main.yml new file mode 100644 index 00000000000..07faa217762 --- /dev/null +++ b/tests/integration/targets/dynamodb_table/meta/main.yml @@ -0,0 +1,2 @@ +dependencies: + - prepare_tests diff --git a/tests/integration/targets/dynamodb_table/tasks/main.yml b/tests/integration/targets/dynamodb_table/tasks/main.yml new file mode 100644 index 00000000000..938351f5625 --- /dev/null +++ b/tests/integration/targets/dynamodb_table/tasks/main.yml @@ -0,0 +1,733 @@ +--- +# dynamodb_table integration tests +# +# Current module limitations: +# - changed very flakey +# - various parameters have defaults set so reset undefined value +# +- module_defaults: + group/aws: + aws_access_key: '{{ aws_access_key }}' + aws_secret_key: '{{ aws_secret_key }}' + security_token: '{{ security_token | default(omit) }}' + region: '{{ aws_region }}' + block: + + # ============================================== + + - name: Create table - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + hash_key_name: '{{ table_index }}' + hash_key_type: '{{ table_index_type }}' + register: create_table + check_mode: True + + - name: Check results - Create table - check_mode + assert: + that: + - create_table is successful + - create_table is changed + - '"hash_key_name" in create_table' + + - name: Create table + dynamodb_table: + state: present + name: '{{ table_name }}' + hash_key_name: '{{ table_index }}' + hash_key_type: '{{ table_index_type }}' + register: create_table + + - name: Check results - Create table + assert: + that: + - create_table is successful + - create_table is changed + - '"hash_key_name" in create_table' + - '"hash_key_type" in create_table' + - '"indexes" in create_table' + - '"range_key_name" in create_table' + - '"range_key_type" in create_table' + - '"read_capacity" in create_table' + - '"region" in create_table' + - '"table_name" in create_table' + - '"table_status" in create_table' + - '"write_capacity" in create_table' + - create_table.hash_key_name == table_index + - create_table.hash_key_type == table_index_type + - create_table.indexes | length == 0 + - create_table.range_key_name is none + - create_table.range_key_type == "STRING" + - create_table.read_capacity == 1 + - create_table.table_name == table_name + - create_table.write_capacity == 1 + + - name: Create table - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + hash_key_name: '{{ table_index }}' + hash_key_type: '{{ table_index_type }}' + register: create_table + check_mode: True + + - name: Check results - Create table - idempotent - check_mode + assert: + that: + - create_table is successful + - create_table is not changed + + - name: Create table - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + hash_key_name: '{{ table_index }}' + hash_key_type: '{{ table_index_type }}' + register: create_table + + - name: Check results - Create table - idempotent + assert: + that: + - create_table is successful + - create_table is not changed + - '"hash_key_name" in create_table' + - '"hash_key_type" in create_table' + - '"indexes" in create_table' + - '"range_key_name" in create_table' + - '"range_key_type" in create_table' + - '"read_capacity" in create_table' + - '"region" in create_table' + - '"table_name" in create_table' + - '"table_status" in create_table' + - '"write_capacity" in create_table' + - create_table.hash_key_name == table_index + - create_table.hash_key_type == table_index_type + - create_table.indexes | length == 0 + - create_table.range_key_name is none + - create_table.range_key_type == "STRING" + - create_table.read_capacity == 1 + - create_table.table_name == table_name + - create_table.write_capacity == 1 + + # ============================================== + + - name: Tag table - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + tags: '{{ tags_default }}' + register: tag_table + check_mode: True + + - name: Check results - Tag table - check_mode + assert: + that: + - tag_table is successful + # XXX bug updating (just) tags doesn't return 'changed' + # - tag_table is changed + + - name: Tag table + dynamodb_table: + state: present + name: '{{ table_name }}' + tags: '{{ tags_default }}' + register: tag_table + + - name: Check results - Tag table + assert: + that: + - tag_table is successful + # XXX bug updating (just) tags doesn't return 'changed' + # - tag_table is changed + - '"hash_key_name" in tag_table' + - '"hash_key_type" in tag_table' + - '"indexes" in tag_table' + - '"range_key_name" in tag_table' + - '"range_key_type" in tag_table' + - '"read_capacity" in tag_table' + - '"region" in tag_table' + - '"table_name" in tag_table' + - '"table_status" in tag_table' + - '"write_capacity" in tag_table' + # XXX Bug - returns none when not actively set + # - tag_table.hash_key_name == table_index + # XXX Bug - returns string when not actively set + #- tag_table.hash_key_type == table_index_type + - tag_table.indexes | length == 0 + - tag_table.range_key_name is none + - tag_table.range_key_type == "STRING" + - tag_table.read_capacity == 1 + - tag_table.table_name == table_name + - tag_table.write_capacity == 1 + - tag_table.tags == tags_default + + - name: Tag table - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + tags: '{{ tags_default }}' + register: tag_table + check_mode: True + + - name: Check results - Tag table - idempotent - check_mode + assert: + that: + - tag_table is successful + - tag_table is not changed + + - name: Tag table - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + tags: '{{ tags_default }}' + register: tag_table + + - name: Check results - Tag table - idempotent + assert: + that: + - tag_table is successful + - tag_table is not changed + - '"hash_key_name" in tag_table' + - '"hash_key_type" in tag_table' + - '"indexes" in tag_table' + - '"range_key_name" in tag_table' + - '"range_key_type" in tag_table' + - '"read_capacity" in tag_table' + - '"region" in tag_table' + - '"table_name" in tag_table' + - '"table_status" in tag_table' + - '"write_capacity" in tag_table' + # XXX Bug - returns none when not actively set + # - tag_table.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - tag_table.hash_key_type == table_index_type + - tag_table.indexes | length == 0 + - tag_table.range_key_name is none + - tag_table.range_key_type == "STRING" + - tag_table.read_capacity == 1 + - tag_table.table_name == table_name + - tag_table.write_capacity == 1 + - tag_table.tags == tags_default + + # ============================================== + + - name: Update table read capacity - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + read_capacity: 3 + register: update_read + check_mode: True + + - name: Check results - Update table read capacity - check_mode + assert: + that: + - update_read is successful + - update_read is changed + + - name: Update table read capacity + dynamodb_table: + state: present + name: '{{ table_name }}' + read_capacity: 3 + register: update_read + + - name: Check results - Update table read capacity + assert: + that: + - update_read is successful + - update_read is changed + - '"hash_key_name" in update_read' + - '"hash_key_type" in update_read' + - '"indexes" in update_read' + - '"range_key_name" in update_read' + - '"range_key_type" in update_read' + - '"read_capacity" in update_read' + - '"region" in update_read' + - '"table_name" in update_read' + - '"table_status" in update_read' + - '"write_capacity" in update_read' + # XXX Bug - returns none when not actively set + # - update_read.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_read.hash_key_type == table_index_type + - update_read.indexes | length == 0 + - update_read.range_key_name is none + - update_read.range_key_type == "STRING" + - update_read.read_capacity == 3 + - update_read.table_name == table_name + - update_read.write_capacity == 1 + # Tags are only returned when tagging + # - update_read.tags == tags_default + + - name: Update table read capacity - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + read_capacity: 3 + register: update_read + check_mode: True + + - name: Check results - Update table read capacity - idempotent - check_mode + assert: + that: + - update_read is successful + # XXX Bug - returns changed + # - update_read is not changed + + - name: Update table read capacity - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + read_capacity: 3 + register: update_read + # Can result in ResourceInUseException - change in flight + until: update_read is successful + retries: 15 + delay: 10 + + - name: Check results - Update table read capacity - idempotent + assert: + that: + - update_read is successful + - update_read is not changed + - '"hash_key_name" in update_read' + - '"hash_key_type" in update_read' + - '"indexes" in update_read' + - '"range_key_name" in update_read' + - '"range_key_type" in update_read' + - '"read_capacity" in update_read' + - '"region" in update_read' + - '"table_name" in update_read' + - '"table_status" in update_read' + - '"write_capacity" in update_read' + # XXX Bug - returns none when not actively set + # - update_read.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_read.hash_key_type == table_index_type + - update_read.indexes | length == 0 + - update_read.range_key_name is none + - update_read.range_key_type == "STRING" + - update_read.read_capacity == 3 + - update_read.table_name == table_name + - update_read.write_capacity == 1 + # Tags are only returned when tagging + # - update_read.tags == tags_default + + # ============================================== + + - name: Update table write capacity - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + write_capacity: 3 + register: update_write + check_mode: True + + - name: Check results - Update table write capacity - check_mode + assert: + that: + - update_write is successful + - update_write is changed + + - name: Update table write capacity + dynamodb_table: + state: present + name: '{{ table_name }}' + write_capacity: 3 + register: update_write + + - name: Check results - Update table write capacity + assert: + that: + - update_write is successful + - update_write is changed + - '"hash_key_name" in update_write' + - '"hash_key_type" in update_write' + - '"indexes" in update_write' + - '"range_key_name" in update_write' + - '"range_key_type" in update_write' + - '"read_capacity" in update_write' + - '"region" in update_write' + - '"table_name" in update_write' + - '"table_status" in update_write' + - '"write_capacity" in update_write' + # XXX Bug - returns none when not actively set + # - update_write.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_write.hash_key_type == table_index_type + - update_write.indexes | length == 0 + - update_write.range_key_name is none + - update_write.range_key_type == "STRING" + # XXX Bug - gets reset to 1 because a default was set + # - update_write.read_capacity == 3 + - update_write.table_name == table_name + - update_write.write_capacity == 3 + # Tags are only returned when tagging + # - update_write.tags == tags_default + + - name: Update table write capacity - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + write_capacity: 3 + register: update_write + check_mode: True + + - name: Check results - Update table write capacity - idempotent - check_mode + assert: + that: + - update_write is successful + # XXX Bug - returns changed + # - update_write is not changed + + - name: Update table write capacity - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + write_capacity: 3 + register: update_write + # Can result in ResourceInUseException - change in flight + until: update_write is successful + retries: 15 + delay: 10 + + - name: Check results - Update table write capacity - idempotent + assert: + that: + - update_write is successful + # XXX Bug - returns changed + # - update_write is not changed + - '"hash_key_name" in update_write' + - '"hash_key_type" in update_write' + - '"indexes" in update_write' + - '"range_key_name" in update_write' + - '"range_key_type" in update_write' + - '"read_capacity" in update_write' + - '"region" in update_write' + - '"table_name" in update_write' + - '"table_status" in update_write' + - '"write_capacity" in update_write' + # XXX Bug - returns none when not actively set + # - update_write.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_write.hash_key_type == table_index_type + - update_write.indexes | length == 0 + - update_write.range_key_name is none + - update_write.range_key_type == "STRING" + # XXX Bug - gets reset to 1 because a default was set + # - update_write.read_capacity == 3 + - update_write.table_name == table_name + - update_write.write_capacity == 3 + # Tags are only returned when tagging + # - update_write.tags == tags_default + + # ============================================== + + - name: Update table add range index - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + range_key_name: '{{ range_index }}' + range_key_type: '{{ range_index_type }}' + register: update_range_index + check_mode: True + + - name: Check results - Update table add range index - check_mode + assert: + that: + - update_range_index is successful + - update_range_index is changed + + - name: Update table write capacity + dynamodb_table: + state: present + name: '{{ table_name }}' + range_key_name: '{{ range_index }}' + range_key_type: '{{ range_index_type }}' + register: update_range_index + + - name: Check results - Update table add range index + assert: + that: + - update_range_index is successful + - update_range_index is changed + - '"hash_key_name" in update_range_index' + - '"hash_key_type" in update_range_index' + - '"indexes" in update_range_index' + - '"range_key_name" in update_range_index' + - '"range_key_type" in update_range_index' + - '"read_capacity" in update_range_index' + - '"region" in update_range_index' + - '"table_name" in update_range_index' + - '"table_status" in update_range_index' + - '"write_capacity" in update_range_index' + # XXX Bug - returns none when not actively set + # - update_range_index.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_range_index.hash_key_type == table_index_type + - update_range_index.indexes | length == 0 + - update_range_index.range_key_name == range_index + - update_range_index.range_key_type == range_index_type + # XXX Bug - gets reset to 1 because a default was set + # - update_range_index.read_capacity == 3 + - update_range_index.table_name == table_name + # XXX Bug - gets reset to 1 because a default was set + # - update_range_index.write_capacity == 3 + # Tags are only returned when tagging + # - update_range_index.tags == tags_default + + - name: Update table add range index - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + range_key_name: '{{ range_index }}' + range_key_type: '{{ range_index_type }}' + register: update_range_index + check_mode: True + + - name: Check results - Update table add range index - idempotent - check_mode + assert: + that: + - update_range_index is successful + # XXX Bug - returns changed + # - update_range_index is not changed + + - name: Update table add range index - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + range_key_name: '{{ range_index }}' + range_key_type: '{{ range_index_type }}' + register: update_range_index + # Can result in ResourceInUseException - change in flight + until: update_range_index is successful + retries: 15 + delay: 10 + + - name: Check results - Update table add range index - idempotent + assert: + that: + - update_range_index is successful + # XXX Bug - returns changed + # - update_range_index is not changed + - '"hash_key_name" in update_range_index' + - '"hash_key_type" in update_range_index' + - '"indexes" in update_range_index' + - '"range_key_name" in update_range_index' + - '"range_key_type" in update_range_index' + - '"read_capacity" in update_range_index' + - '"region" in update_range_index' + - '"table_name" in update_range_index' + - '"table_status" in update_range_index' + - '"write_capacity" in update_range_index' + # XXX Bug - returns none when not actively set + # - update_range_index.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_range_index.hash_key_type == table_index_type + - update_range_index.indexes | length == 0 + - update_range_index.range_key_name == range_index + - update_range_index.range_key_type == range_index_type + # XXX Bug - gets reset to 1 because a default was set + # - update_range_index.read_capacity == 3 + - update_range_index.table_name == table_name + # XXX Bug - gets reset to 1 because a default was set + # - update_range_index.write_capacity == 3 + # Tags are only returned when tagging + # - update_range_index.tags == tags_default + + # ============================================== + + - name: Update table add indexes - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + indexes: '{{ indexes }}' + register: update_indexes + check_mode: True + + - name: Check results - Update table add indexes - check_mode + assert: + that: + - update_indexes is successful + - update_indexes is changed + + - name: Update table add indexes + dynamodb_table: + state: present + name: '{{ table_name }}' + indexes: '{{ indexes }}' + register: update_indexes + # Can result in LimitExceededException - change in flight + until: update_indexes is successful + retries: 45 + delay: 10 + + - name: Check results - Update table add indexes + assert: + that: + - update_indexes is successful + - update_indexes is changed + - '"hash_key_name" in update_indexes' + - '"hash_key_type" in update_indexes' + - '"indexes" in update_indexes' + - '"range_key_name" in update_indexes' + - '"range_key_type" in update_indexes' + - '"read_capacity" in update_indexes' + - '"region" in update_indexes' + - '"table_name" in update_indexes' + - '"table_status" in update_indexes' + - '"write_capacity" in update_indexes' + # XXX Bug - returns none when not actively set + # - update_indexes.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_indexes.hash_key_type == table_index_type + - update_indexes.indexes | length == 2 + # XXX Bug - returns none when not actively set + # - update_indexes.range_key_name == range_index + # XXX Bug - returns string when not actively set + # - update_indexes.range_key_type == range_index_type + # XXX Bug - gets reset to 1 because a default was set + # - update_indexes.read_capacity == 3 + - update_indexes.table_name == table_name + # XXX Bug - gets reset to 1 because a default was set + # - update_indexes.write_capacity == 3 + # Tags are only returned when tagging + # - update_indexes.tags == tags_default + + - name: Update table add indexes - idempotent - check_mode + dynamodb_table: + state: present + name: '{{ table_name }}' + indexes: '{{ indexes }}' + register: update_indexes + check_mode: True + + - name: Check results - Update table add indexes - idempotent - check_mode + assert: + that: + - update_indexes is successful + # XXX Bug - returns changed + # - update_indexes is not changed + + - name: Update table add indexes - idempotent + dynamodb_table: + state: present + name: '{{ table_name }}' + indexes: '{{ indexes }}' + register: update_indexes + # Can result in LimitExceededException - change in flight + until: update_indexes is successful + retries: 45 + delay: 10 + + - name: Check results - Update table add indexes - idempotent + assert: + that: + - update_indexes is successful + # XXX Bug - returns changed + # - update_indexes is not changed + - '"hash_key_name" in update_indexes' + - '"hash_key_type" in update_indexes' + - '"indexes" in update_indexes' + - '"range_key_name" in update_indexes' + - '"range_key_type" in update_indexes' + - '"read_capacity" in update_indexes' + - '"region" in update_indexes' + - '"table_name" in update_indexes' + - '"table_status" in update_indexes' + - '"write_capacity" in update_indexes' + # XXX Bug - returns none when not actively set + # - update_indexes.hash_key_name == table_index + # XXX Bug - returns string when not actively set + # - update_indexes.hash_key_type == table_index_type + - update_indexes.indexes | length == 2 + # XXX Bug - returns none when not actively set + # - update_indexes.range_key_name == range_index + # XXX Bug - returns string when not actively set + # - update_indexes.range_key_type == range_index_type + # XXX Bug - gets reset to 1 because a default was set + # - update_indexes.read_capacity == 3 + - update_indexes.table_name == table_name + # XXX Bug - gets reset to 1 because a default was set + # - update_indexes.write_capacity == 3 + # Tags are only returned when tagging + # - update_indexes.tags == tags_default + + # ============================================== + + - name: Delete table - check_mode + dynamodb_table: + state: absent + name: '{{ table_name }}' + register: delete_table + check_mode: True + + - name: Check results - Delete table - check_mode + assert: + that: + - delete_table is successful + - delete_table is changed + + - name: Delete table + dynamodb_table: + state: absent + name: '{{ table_name }}' + register: delete_table + # Updates don't support waiting yet, so retry until successful + until: delete_table is successful + retries: 45 + delay: 10 + + - name: Check results - Delete table + assert: + that: + - delete_table is successful + - delete_table is changed + + - name: Delete table - idempotent - check_mode + dynamodb_table: + state: absent + name: '{{ table_name }}' + register: delete_table + check_mode: True + + - name: Check results - Delete table - idempotent - check_mode + assert: + that: + - delete_table is successful + # XXX bug - returns changed + # - delete_table is not changed + + - name: Delete table - idempotent + dynamodb_table: + state: absent + name: '{{ table_name }}' + register: delete_table + # Deletion doesn't support waiting yet, so retry until successful + until: delete_table is successful + retries: 45 + delay: 10 + + - name: Check results - Delete table - idempotent + assert: + that: + - delete_table is successful + - delete_table is not changed + + always: + + ################################################ + # TEARDOWN STARTS HERE + ################################################ + + - name: Clean up table + dynamodb_table: + state: absent + name: '{{ table_name }}' + register: delete_table + # Can result in LimitExceededException or ResourceInUseException - changes in flight + until: delete_table is successful + retries: 40 + delay: 10 diff --git a/tests/integration/targets/ec2_eip/tasks/main.yml b/tests/integration/targets/ec2_eip/tasks/main.yml index 83093572697..9f03f5b5647 100644 --- a/tests/integration/targets/ec2_eip/tasks/main.yml +++ b/tests/integration/targets/ec2_eip/tasks/main.yml @@ -662,6 +662,25 @@ state: absent name: '{{ resource_prefix }}-vpc' cidr_block: '{{ vpc_cidr }}' + + - name: Create an EIP outside a VPC + ec2_eip: + state: present + in_vpc: '{{ omit }}' + register: unbound_eip + - assert: + that: + - unbound_eip is successful + - unbound_eip is changed + - name: Release EIP + ec2_eip: + state: absent + public_ip: '{{ unbound_eip.public_ip }}' + register: release_unbound_eip + - assert: + that: + - release_unbound_eip is successful + - release_unbound_eip is changed # ===================================================== always: - name: Cleanup instance (by id) @@ -735,6 +754,12 @@ public_ip: '{{ no_tagged_eip.public_ip }}' when: no_tagged_eip is changed ignore_errors: true + - name: Cleanup unbound_eip + ec2_eip: + state: absent + public_ip: '{{ unbound_eip.public_ip }}' + when: unbound_eip is changed + ignore_errors: true - name: Cleanup VPC ec2_vpc_net: state: absent diff --git a/tests/integration/targets/elasticache/aliases b/tests/integration/targets/elasticache/aliases index 88ef7754817..5ee1d22add8 100644 --- a/tests/integration/targets/elasticache/aliases +++ b/tests/integration/targets/elasticache/aliases @@ -3,5 +3,3 @@ unstable cloud/aws - -elasticache_subnet_group diff --git a/tests/integration/targets/elasticache_subnet_group/aliases b/tests/integration/targets/elasticache_subnet_group/aliases new file mode 100644 index 00000000000..4ef4b2067d0 --- /dev/null +++ b/tests/integration/targets/elasticache_subnet_group/aliases @@ -0,0 +1 @@ +cloud/aws diff --git a/tests/integration/targets/elasticache_subnet_group/defaults/main.yml b/tests/integration/targets/elasticache_subnet_group/defaults/main.yml new file mode 100644 index 00000000000..ea8921880a9 --- /dev/null +++ b/tests/integration/targets/elasticache_subnet_group/defaults/main.yml @@ -0,0 +1,42 @@ +--- +availability_zone: '{{ ec2_availability_zone_names[0] }}' + +vpc_name: '{{ resource_prefix }}' +subnet_name_a: '{{ resource_prefix }}-a' +subnet_name_b: '{{ resource_prefix }}-b' +subnet_name_c: '{{ resource_prefix }}-c' +subnet_name_d: '{{ resource_prefix }}-d' + +vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' +subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' +subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' +subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' +subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' + +subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' +subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' +subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' +subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' + +group_name: '{{ resource_prefix }}' +description_default: 'Subnet Description' +description_updated: 'updated subnet description' + +# Tagging not currently supported, planned with boto3 upgrade +tags_default: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + PascalCaseKey: PascalCaseValue + 'key with spaces': value with spaces + 'Upper With Spaces': Upper With Spaces + +partial_tags: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + +updated_tags: + updated_snake_case_key: updated_snake_case_value + updatedCamelCaseKey: updatedCamelCaseValue + UpdatedPascalCaseKey: UpdatedPascalCaseValue + 'updated key with spaces': updated value with spaces + 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/elasticache_subnet_group/meta/main.yml b/tests/integration/targets/elasticache_subnet_group/meta/main.yml new file mode 100644 index 00000000000..930e8622824 --- /dev/null +++ b/tests/integration/targets/elasticache_subnet_group/meta/main.yml @@ -0,0 +1,3 @@ +dependencies: + - prepare_tests + - setup_ec2_facts diff --git a/tests/integration/targets/elasticache_subnet_group/tasks/main.yml b/tests/integration/targets/elasticache_subnet_group/tasks/main.yml new file mode 100644 index 00000000000..5814f9dc90d --- /dev/null +++ b/tests/integration/targets/elasticache_subnet_group/tasks/main.yml @@ -0,0 +1,681 @@ +--- +# elasticache_subnet_group integration tests +# +# Current module limitations: +# - check_mode not supported +# - Tagging not supported +# - Returned values *very* limited (almost none) +# +- module_defaults: + group/aws: + aws_access_key: '{{ aws_access_key }}' + aws_secret_key: '{{ aws_secret_key }}' + security_token: '{{ security_token | default(omit) }}' + region: '{{ aws_region }}' + block: + + # ============================================================ + + - name: Create Subnet Group with no subnets - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + check_mode: True + register: create_group + ignore_errors: True + + - name: Check result - Create Subnet Group with no subnets - check_mode + assert: + that: + - create_group is failed + # Check we caught the issue before trying to create + - '"CreateCacheSubnetGroup" not in create_group.resource_actions' + # Check that we don't refer to the boto3 parameter + - '"SubnetIds" not in create_group.msg' + # Loosely check the message + - '"subnet" in create_group.msg' + - '"At least" in create_group.msg' + + - name: Create Subnet Group with no subnets + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + register: create_group + ignore_errors: True + + - name: Check result - Create Subnet Group with no subnets + assert: + that: + - create_group is failed + # Check we caught the issue before trying to create + - '"CreateCacheSubnetGroup" not in create_group.resource_actions' + # Check that we don't refer to the boto3 parameter + - '"SubnetIds" not in create_group.msg' + # Loosely check the message + - '"subnet" in create_group.msg' + - '"At least" in create_group.msg' + + # ============================================================ + # Setup infra needed for tests + - name: create a VPC + ec2_vpc_net: + state: present + name: '{{ vpc_name }}' + cidr_block: '{{ vpc_cidr }}' + tags: + TestPrefix: '{{ resource_prefix }}' + register: vpc_result + + - name: create subnets + ec2_vpc_subnet: + state: present + cidr: '{{ item.cidr }}' + az: '{{ item.zone }}' + vpc_id: '{{ vpc_result.vpc.id }}' + tags: + Name: '{{ item.name }}' + TestPrefix: '{{ resource_prefix }}' + register: vpc_subnet_create + loop: + - name: '{{ subnet_name_a }}' + cidr: '{{ subnet_cidr_a }}' + zone: '{{ subnet_zone_a }}' + - name: '{{ subnet_name_b }}' + cidr: '{{ subnet_cidr_b }}' + zone: '{{ subnet_zone_b }}' + - name: '{{ subnet_name_c }}' + cidr: '{{ subnet_cidr_c }}' + zone: '{{ subnet_zone_c }}' + - name: '{{ subnet_name_d }}' + cidr: '{{ subnet_cidr_d }}' + zone: '{{ subnet_zone_d }}' + + - name: Store IDs of subnets and VPC + set_fact: + vpc_id: '{{ vpc_result.vpc.id }}' + subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' + subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' + subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' + subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' + + # ============================================================ + + - name: Create Subnet Group - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_default }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + check_mode: True + register: create_group + + - name: Check result - Create Subnet Group - check_mode + assert: + that: + - create_group is successful + - create_group is changed + + - name: Create Subnet Group + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_default }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + + - name: Check result - Create Subnet Group + assert: + that: + - create_group is successful + - create_group is changed + - '"cache_subnet_group" in create_group' + - '"arn" in create_group.cache_subnet_group' + - '"description" in create_group.cache_subnet_group' + - '"name" in create_group.cache_subnet_group' + - '"subnet_ids" in create_group.cache_subnet_group' + - '"vpc_id" in create_group.cache_subnet_group' + - create_group.cache_subnet_group.description == description_default + - create_group.cache_subnet_group.name == group_name + - subnet_id_a in create_group.cache_subnet_group.subnet_ids + - subnet_id_b in create_group.cache_subnet_group.subnet_ids + - subnet_id_c not in create_group.cache_subnet_group.subnet_ids + - subnet_id_d not in create_group.cache_subnet_group.subnet_ids + - create_group.cache_subnet_group.vpc_id == vpc_id + - create_group.cache_subnet_group.arn.startswith('arn:') + - create_group.cache_subnet_group.arn.endswith(group_name) + + - name: Create Subnet Group - idempotency - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_default }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + check_mode: True + register: create_group + + - name: Check result - Create Subnet Group - idempotency - check_mode + assert: + that: + - create_group is successful + - create_group is not changed + + - name: Create Subnet Group - idempotency + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_default }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + + - name: Check result - Create Subnet Group - idempotency + assert: + that: + - create_group is successful + - create_group is not changed + - '"cache_subnet_group" in create_group' + - '"arn" in create_group.cache_subnet_group' + - '"description" in create_group.cache_subnet_group' + - '"name" in create_group.cache_subnet_group' + - '"subnet_ids" in create_group.cache_subnet_group' + - '"vpc_id" in create_group.cache_subnet_group' + - create_group.cache_subnet_group.description == description_default + - create_group.cache_subnet_group.name == group_name + - subnet_id_a in create_group.cache_subnet_group.subnet_ids + - subnet_id_b in create_group.cache_subnet_group.subnet_ids + - subnet_id_c not in create_group.cache_subnet_group.subnet_ids + - subnet_id_d not in create_group.cache_subnet_group.subnet_ids + - create_group.cache_subnet_group.vpc_id == vpc_id + - create_group.cache_subnet_group.arn.startswith('arn:') + - create_group.cache_subnet_group.arn.endswith(group_name) + + # ============================================================ + + - name: Update Subnet Group Description - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + ## No longer mandatory + # subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + check_mode: True + register: update_description + + - name: Check result - Update Subnet Group Description - check_mode + assert: + that: + - update_description is successful + - update_description is changed + + - name: Update Subnet Group Description + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + ## No longer mandatory + # subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + + - name: Check result - Update Subnet Group Description + assert: + that: + - update_description is successful + - update_description is changed + - '"cache_subnet_group" in update_description' + - '"arn" in update_description.cache_subnet_group' + - '"description" in update_description.cache_subnet_group' + - '"name" in update_description.cache_subnet_group' + - '"subnet_ids" in update_description.cache_subnet_group' + - '"vpc_id" in update_description.cache_subnet_group' + - update_description.cache_subnet_group.description == description_updated + - update_description.cache_subnet_group.name == group_name + - subnet_id_a in update_description.cache_subnet_group.subnet_ids + - subnet_id_b in update_description.cache_subnet_group.subnet_ids + - subnet_id_c not in update_description.cache_subnet_group.subnet_ids + - subnet_id_d not in update_description.cache_subnet_group.subnet_ids + - update_description.cache_subnet_group.vpc_id == vpc_id + - update_description.cache_subnet_group.arn.startswith('arn:') + - update_description.cache_subnet_group.arn.endswith(group_name) + + - name: Update Subnet Group Description - idempotency - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + ## No longer mandatory + # subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + check_mode: True + register: update_description + + - name: Check result - Update Subnet Group Description - idempotency - check_mode + assert: + that: + - update_description is successful + - update_description is not changed + + - name: Update Subnet Group Description - idempotency + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + ## No longer mandatory + # subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + + - name: Check result - Update Subnet Group Description - idempotency + assert: + that: + - update_description is successful + - update_description is not changed + - '"cache_subnet_group" in update_description' + - '"arn" in update_description.cache_subnet_group' + - '"description" in update_description.cache_subnet_group' + - '"name" in update_description.cache_subnet_group' + - '"subnet_ids" in update_description.cache_subnet_group' + - '"vpc_id" in update_description.cache_subnet_group' + - update_description.cache_subnet_group.description == description_updated + - update_description.cache_subnet_group.name == group_name + - subnet_id_a in update_description.cache_subnet_group.subnet_ids + - subnet_id_b in update_description.cache_subnet_group.subnet_ids + - subnet_id_c not in update_description.cache_subnet_group.subnet_ids + - subnet_id_d not in update_description.cache_subnet_group.subnet_ids + - update_description.cache_subnet_group.vpc_id == vpc_id + - update_description.cache_subnet_group.arn.startswith('arn:') + - update_description.cache_subnet_group.arn.endswith(group_name) + + # ============================================================ + + - name: Update Subnet Group subnets - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + ## No longer mandatory + # description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + check_mode: True + register: update_subnets + + - name: Check result - Update Subnet Group subnets - check_mode + assert: + that: + - update_subnets is successful + - update_subnets is changed + + - name: Update Subnet Group subnets + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + ## No longer mandatory + # description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + + - name: Check result - Update Subnet Group subnets + assert: + that: + - update_subnets is successful + - update_subnets is changed + - '"cache_subnet_group" in update_subnets' + - '"arn" in update_subnets.cache_subnet_group' + - '"description" in update_subnets.cache_subnet_group' + - '"name" in update_subnets.cache_subnet_group' + - '"subnet_ids" in update_subnets.cache_subnet_group' + - '"vpc_id" in update_subnets.cache_subnet_group' + - update_subnets.cache_subnet_group.description == description_updated + - update_subnets.cache_subnet_group.name == group_name + - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids + - update_subnets.cache_subnet_group.vpc_id == vpc_id + - update_subnets.cache_subnet_group.arn.startswith('arn:') + - update_subnets.cache_subnet_group.arn.endswith(group_name) + + - name: Update Subnet Group subnets - idempotency - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + ## No longer mandatory + # description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + check_mode: True + register: update_subnets + + - name: Check result - Update Subnet Group subnets - idempotency - check_mode + assert: + that: + - update_subnets is successful + - update_subnets is not changed + + - name: Update Subnet Group subnets - idempotency + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + ## No longer mandatory + # description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + + - name: Check result - Update Subnet Group subnets - idempotency + assert: + that: + - update_subnets is successful + - update_subnets is not changed + - '"cache_subnet_group" in update_subnets' + - '"arn" in update_subnets.cache_subnet_group' + - '"description" in update_subnets.cache_subnet_group' + - '"name" in update_subnets.cache_subnet_group' + - '"subnet_ids" in update_subnets.cache_subnet_group' + - '"vpc_id" in update_subnets.cache_subnet_group' + - update_subnets.cache_subnet_group.description == description_updated + - update_subnets.cache_subnet_group.name == group_name + - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids + - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids + - update_subnets.cache_subnet_group.vpc_id == vpc_id + - update_subnets.cache_subnet_group.arn.startswith('arn:') + - update_subnets.cache_subnet_group.arn.endswith(group_name) + + # ============================================================ + + - name: Delete Subnet Group - check_mode + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + check_mode: True + register: delete_group + + - name: Check result - Delete Subnet Group - check_mode + assert: + that: + - delete_group is changed + + - name: Delete Subnet Group + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group + assert: + that: + - delete_group is changed + + - name: Delete Subnet Group - idempotency - check_mode + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + check_mode: True + register: delete_group + + - name: Check result - Delete Subnet Group - idempotency - check_mode + assert: + that: + - delete_group is not changed + + - name: Delete Subnet Group - idempotency + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group - idempotency + assert: + that: + - delete_group is not changed + + # ============================================================ + + - name: Create minimal Subnet Group - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + check_mode: True + register: create_group + + - name: Check result - Create minimal Subnet Group - check_mode + assert: + that: + - create_group is successful + - create_group is changed + + - name: Create minimal Subnet Group + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + + - name: Check result - Create minimal Subnet Group + assert: + that: + - create_group is successful + - create_group is changed + - '"cache_subnet_group" in create_group' + - '"arn" in create_group.cache_subnet_group' + - '"description" in create_group.cache_subnet_group' + - '"name" in create_group.cache_subnet_group' + - '"subnet_ids" in create_group.cache_subnet_group' + - '"vpc_id" in create_group.cache_subnet_group' + - create_group.cache_subnet_group.description == group_name + - create_group.cache_subnet_group.name == group_name + - subnet_id_a in create_group.cache_subnet_group.subnet_ids + - subnet_id_b not in create_group.cache_subnet_group.subnet_ids + - subnet_id_c not in create_group.cache_subnet_group.subnet_ids + - subnet_id_d not in create_group.cache_subnet_group.subnet_ids + - create_group.cache_subnet_group.vpc_id == vpc_id + - create_group.cache_subnet_group.arn.startswith('arn:') + - create_group.cache_subnet_group.arn.endswith(group_name) + + - name: Create minimal Subnet Group - idempotency - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + check_mode: True + register: create_group + + - name: Check result - Create minimal Subnet Group - idempotency - check_mode + assert: + that: + - create_group is successful + - create_group is not changed + + - name: Create minimal Subnet Group - idempotency + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + + - name: Check result - Create minimal Subnet Group - idempotency + assert: + that: + - create_group is successful + - create_group is not changed + - '"cache_subnet_group" in create_group' + - '"arn" in create_group.cache_subnet_group' + - '"description" in create_group.cache_subnet_group' + - '"name" in create_group.cache_subnet_group' + - '"subnet_ids" in create_group.cache_subnet_group' + - '"vpc_id" in create_group.cache_subnet_group' + - create_group.cache_subnet_group.description == group_name + - create_group.cache_subnet_group.name == group_name + - subnet_id_a in create_group.cache_subnet_group.subnet_ids + - subnet_id_b not in create_group.cache_subnet_group.subnet_ids + - subnet_id_c not in create_group.cache_subnet_group.subnet_ids + - subnet_id_d not in create_group.cache_subnet_group.subnet_ids + - create_group.cache_subnet_group.vpc_id == vpc_id + - create_group.cache_subnet_group.arn.startswith('arn:') + - create_group.cache_subnet_group.arn.endswith(group_name) + + # ============================================================ + + - name: Full Update Subnet Group - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + check_mode: True + register: update_complex + + - name: Check result - Full Update Subnet Group - check_mode + assert: + that: + - update_complex is successful + - update_complex is changed + + - name: Update Subnet Group + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + + - name: Check result - Full Update Subnet Group + assert: + that: + - update_complex is successful + - update_complex is changed + - '"cache_subnet_group" in update_complex' + - '"arn" in update_complex.cache_subnet_group' + - '"description" in update_complex.cache_subnet_group' + - '"name" in update_complex.cache_subnet_group' + - '"subnet_ids" in update_complex.cache_subnet_group' + - '"vpc_id" in update_complex.cache_subnet_group' + - update_complex.cache_subnet_group.description == description_updated + - update_complex.cache_subnet_group.name == group_name + - subnet_id_a in update_complex.cache_subnet_group.subnet_ids + - subnet_id_b in update_complex.cache_subnet_group.subnet_ids + - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids + - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids + - update_complex.cache_subnet_group.vpc_id == vpc_id + - update_complex.cache_subnet_group.arn.startswith('arn:') + - update_complex.cache_subnet_group.arn.endswith(group_name) + + - name: Full Update Subnet Group - idempotency - check_mode + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + check_mode: True + register: update_complex + + - name: Check result - Full Update Subnet Group - idempotency - check_mode + assert: + that: + - update_complex is successful + - update_complex is not changed + + - name: Full Update Subnet Group - idempotency + elasticache_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + + - name: Check result - Full Update Subnet Group - idempotency + assert: + that: + - update_complex is successful + - update_complex is not changed + - '"cache_subnet_group" in update_complex' + - '"arn" in update_complex.cache_subnet_group' + - '"description" in update_complex.cache_subnet_group' + - '"name" in update_complex.cache_subnet_group' + - '"subnet_ids" in update_complex.cache_subnet_group' + - '"vpc_id" in update_complex.cache_subnet_group' + - update_complex.cache_subnet_group.description == description_updated + - update_complex.cache_subnet_group.name == group_name + - subnet_id_a in update_complex.cache_subnet_group.subnet_ids + - subnet_id_b in update_complex.cache_subnet_group.subnet_ids + - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids + - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids + - update_complex.cache_subnet_group.vpc_id == vpc_id + - update_complex.cache_subnet_group.arn.startswith('arn:') + - update_complex.cache_subnet_group.arn.endswith(group_name) + + # ============================================================ + + - name: Delete Subnet Group + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group + assert: + that: + - delete_group is changed + + always: + + ################################################ + # TEARDOWN STARTS HERE + ################################################ + + - name: Delete Subnet Group + elasticache_subnet_group: + state: absent + name: '{{ group_name }}' + ignore_errors: True + + - name: tidy up subnet + ec2_vpc_subnet: + state: absent + cidr: '{{ item }}' + vpc_id: '{{ vpc_result.vpc.id }}' + loop: + - '{{ subnet_cidr_a }}' + - '{{ subnet_cidr_b }}' + - '{{ subnet_cidr_c }}' + - '{{ subnet_cidr_d }}' + ignore_errors: True + + - name: tidy up VPC + ec2_vpc_net: + state: absent + name: '{{ vpc_name }}' + cidr_block: '{{ vpc_cidr }}' + ignore_errors: True diff --git a/tests/integration/targets/elb_target/tasks/ec2_target.yml b/tests/integration/targets/elb_target/tasks/ec2_target.yml index 108ffa4d30b..f350672cafe 100644 --- a/tests/integration/targets/elb_target/tasks/ec2_target.yml +++ b/tests/integration/targets/elb_target/tasks/ec2_target.yml @@ -17,7 +17,6 @@ - set_fact: ec2_ami_image: '{{ ec2_amis.images[0].image_id }}' - - name: set up testing VPC ec2_vpc_net: name: "{{ resource_prefix }}-vpc" @@ -119,6 +118,33 @@ tags: Description: "Created by {{ resource_prefix }}" + - name: set up testing target group for NLB (type=instance) + elb_target_group: + name: "{{ tg_name }}-nlb" + health_check_port: 80 + protocol: tcp + port: 80 + vpc_id: '{{ vpc.vpc.id }}' + state: present + target_type: instance + tags: + Description: "Created by {{ resource_prefix }}" + register: result + + - name: set up testing target group for NLB (type=instance) + assert: + that: + - result.changed + - '"health_check_port" in result' + - result.port == 80 + - '"health_check_protocol" in result' + - result.health_check_protocol == 'TCP' + - '"tags" in result' + - '"target_group_arn" in result' + - result.target_group_name == "{{ tg_name }}-nlb" + - result.target_type == 'instance' + - result.vpc_id == '{{ vpc.vpc.id }}' + - name: set up ec2 instance to use as a target ec2_instance: name: "{{ resource_prefix }}-inst" @@ -161,6 +187,98 @@ TargetGroupName: "{{ tg_name }}-used" state: present + - name: create a network load balancer + elb_network_lb: + name: "{{ lb_name }}-nlb" + subnets: + - "{{ subnet_1.subnet.id }}" + - "{{ subnet_2.subnet.id }}" + listeners: + - Protocol: TCP + Port: 80 + DefaultActions: + - Type: forward + TargetGroupName: "{{ tg_name }}-nlb" + state: present + register: result + + - name: create a netwok load balancer + assert: + that: + - result.changed + - '"created_time" in result' + - '"load_balancer_arn" in result' + - '"tags" in result' + - result.type == 'network' + - result.vpc_id == '{{ vpc.vpc.id }}' + + - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) + elb_target_group: + name: "{{ tg_name }}-nlb" + health_check_port: 80 + protocol: tcp + port: 80 + vpc_id: '{{ vpc.vpc.id }}' + state: present + target_type: instance + modify_targets: true + preserve_client_ip_enabled: false + tags: + Description: "Created by {{ resource_prefix }}" + register: result + + - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) + assert: + that: + - result.changed + - result.preserve_client_ip_enabled == 'false' + - result.proxy_protocol_v2_enabled == 'false' + + - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) + elb_target_group: + name: "{{ tg_name }}-nlb" + health_check_port: 80 + protocol: tcp + port: 80 + vpc_id: '{{ vpc.vpc.id }}' + state: present + target_type: instance + modify_targets: true + proxy_protocol_v2_enabled: true + tags: + Description: "Created by {{ resource_prefix }}" + register: result + + - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) + assert: + that: + - result.changed + - result.proxy_protocol_v2_enabled == 'true' + - result.preserve_client_ip_enabled == 'false' + + - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) + elb_target_group: + name: "{{ tg_name }}-nlb" + health_check_port: 80 + protocol: tcp + port: 80 + vpc_id: '{{ vpc.vpc.id }}' + state: present + target_type: instance + modify_targets: true + preserve_client_ip_enabled: false + proxy_protocol_v2_enabled: true + tags: + Description: "Created by {{ resource_prefix }}" + register: result + + - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) + assert: + that: + - not result.changed + - result.proxy_protocol_v2_enabled == 'true' + - result.preserve_client_ip_enabled == 'false' + # ============================================================ - name: @@ -363,6 +481,26 @@ - "{{ tg_tcpudp_name }}" ignore_errors: true + - name: remove tcp testing target groups + elb_target_group: + name: "{{ item }}" + protocol: tcp + port: 80 + vpc_id: '{{ vpc.vpc.id }}' + state: absent + target_type: instance + tags: + Description: "Created by {{ resource_prefix }}" + Protocol: "UDP" + wait: true + wait_timeout: 400 + register: removed + retries: 10 + until: removed is not failed + with_items: + - "{{ tg_name }}-nlb" + ignore_errors: true + - name: remove application load balancer elb_application_lb: name: "{{ lb_name }}" @@ -385,6 +523,26 @@ until: removed is not failed ignore_errors: true + - name: remove network load balancer + elb_network_lb: + name: "{{ lb_name }}-nlb" + subnets: + - "{{ subnet_1.subnet.id }}" + - "{{ subnet_2.subnet.id }}" + listeners: + - Protocol: TCP + Port: 80 + DefaultActions: + - Type: forward + TargetGroupName: "{{ tg_name }}-nlb" + state: absent + wait: true + wait_timeout: 400 + register: removed + retries: 10 + until: removed is not failed + ignore_errors: true + - name: remove testing security group ec2_group: state: absent diff --git a/tests/integration/targets/iam_server_certificate/aliases b/tests/integration/targets/iam_server_certificate/aliases new file mode 100644 index 00000000000..98e604ec4b3 --- /dev/null +++ b/tests/integration/targets/iam_server_certificate/aliases @@ -0,0 +1,3 @@ +cloud/aws + +iam_server_certificate_info diff --git a/tests/integration/targets/iam_server_certificate/defaults/main.yml b/tests/integration/targets/iam_server_certificate/defaults/main.yml new file mode 100644 index 00000000000..ed97d539c09 --- /dev/null +++ b/tests/integration/targets/iam_server_certificate/defaults/main.yml @@ -0,0 +1 @@ +--- diff --git a/tests/integration/targets/iam_server_certificate/meta/main.yml b/tests/integration/targets/iam_server_certificate/meta/main.yml new file mode 100644 index 00000000000..cb6005d042c --- /dev/null +++ b/tests/integration/targets/iam_server_certificate/meta/main.yml @@ -0,0 +1,3 @@ +dependencies: + - prepare_tests + - setup_remote_tmp_dir diff --git a/tests/integration/targets/iam_server_certificate/tasks/main.yml b/tests/integration/targets/iam_server_certificate/tasks/main.yml new file mode 100644 index 00000000000..f0c6946728a --- /dev/null +++ b/tests/integration/targets/iam_server_certificate/tasks/main.yml @@ -0,0 +1,34 @@ +--- +# iam_server_certificate integration tests +# +# Current module limitations: +# +- module_defaults: + group/aws: + aws_access_key: '{{ aws_access_key }}' + aws_secret_key: '{{ aws_secret_key }}' + security_token: '{{ security_token | default(omit) }}' + region: '{{ aws_region }}' + block: + # Check that the alias works + - iam_cert: {} + ignore_errors: true + register: iam_cert_alias + + - iam_server_certificate: {} + ignore_errors: true + register: no_args + + - assert: + that: + - iam_cert_alias is failed + - no_args is failed + - no_args.msg == iam_cert_alias.msg + - no_args.msg.startswith('missing required arguments') + + always: + - debug: msg=test + + ################################################ + # TEARDOWN STARTS HERE + ################################################ diff --git a/tests/integration/targets/redshift_subnet_group/aliases b/tests/integration/targets/redshift_subnet_group/aliases new file mode 100644 index 00000000000..4ef4b2067d0 --- /dev/null +++ b/tests/integration/targets/redshift_subnet_group/aliases @@ -0,0 +1 @@ +cloud/aws diff --git a/tests/integration/targets/redshift_subnet_group/defaults/main.yml b/tests/integration/targets/redshift_subnet_group/defaults/main.yml new file mode 100644 index 00000000000..ea8921880a9 --- /dev/null +++ b/tests/integration/targets/redshift_subnet_group/defaults/main.yml @@ -0,0 +1,42 @@ +--- +availability_zone: '{{ ec2_availability_zone_names[0] }}' + +vpc_name: '{{ resource_prefix }}' +subnet_name_a: '{{ resource_prefix }}-a' +subnet_name_b: '{{ resource_prefix }}-b' +subnet_name_c: '{{ resource_prefix }}-c' +subnet_name_d: '{{ resource_prefix }}-d' + +vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' +subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' +subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' +subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' +subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' + +subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' +subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' +subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' +subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' + +group_name: '{{ resource_prefix }}' +description_default: 'Subnet Description' +description_updated: 'updated subnet description' + +# Tagging not currently supported, planned with boto3 upgrade +tags_default: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + PascalCaseKey: PascalCaseValue + 'key with spaces': value with spaces + 'Upper With Spaces': Upper With Spaces + +partial_tags: + snake_case_key: snake_case_value + camelCaseKey: camelCaseValue + +updated_tags: + updated_snake_case_key: updated_snake_case_value + updatedCamelCaseKey: updatedCamelCaseValue + UpdatedPascalCaseKey: UpdatedPascalCaseValue + 'updated key with spaces': updated value with spaces + 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/redshift_subnet_group/meta/main.yml b/tests/integration/targets/redshift_subnet_group/meta/main.yml new file mode 100644 index 00000000000..930e8622824 --- /dev/null +++ b/tests/integration/targets/redshift_subnet_group/meta/main.yml @@ -0,0 +1,3 @@ +dependencies: + - prepare_tests + - setup_ec2_facts diff --git a/tests/integration/targets/redshift_subnet_group/tasks/main.yml b/tests/integration/targets/redshift_subnet_group/tasks/main.yml new file mode 100644 index 00000000000..e15ee9b9313 --- /dev/null +++ b/tests/integration/targets/redshift_subnet_group/tasks/main.yml @@ -0,0 +1,692 @@ +--- +# redshift_subnet_group integration tests +# +# Current module limitations: +# - check_mode not supported +# - Tagging not supported +# - Module is not idempotent +# - Returned values *very* limited +# +- module_defaults: + group/aws: + aws_access_key: '{{ aws_access_key }}' + aws_secret_key: '{{ aws_secret_key }}' + security_token: '{{ security_token | default(omit) }}' + region: '{{ aws_region }}' + block: + + # ============================================================ + + - name: Create Subnet Group with no subnets - check_mode + redshift_subnet_group: + state: present + name: '{{ group_name }}' + register: create_group + ignore_errors: True + check_mode: True + + - name: Check result - Create Subnet Group with no subnets - check_mode + assert: + that: + - create_group is failed + # Check we caught the issue before trying to create + - '"CreateClusterSubnetGroup" not in create_group.resource_actions' + # Check that we don't refer to the boto3 parameter + - '"subnetIds" not in create_group.msg' + # Loosely check the message + - '"subnet" in create_group.msg' + - '"At least" in create_group.msg' + + - name: Create Subnet Group with no subnets + redshift_subnet_group: + state: present + name: '{{ group_name }}' + register: create_group + ignore_errors: True + + - name: Check result - Create Subnet Group with no subnets + assert: + that: + - create_group is failed + # Check we caught the issue before trying to create + - '"CreateClusterSubnetGroup" not in create_group.resource_actions' + # Check that we don't refer to the boto3 parameter + - '"subnetIds" not in create_group.msg' + # Loosely check the message + - '"subnet" in create_group.msg' + - '"At least" in create_group.msg' + + # ============================================================ + # Setup infra needed for tests + - name: create a VPC + ec2_vpc_net: + state: present + name: '{{ vpc_name }}' + cidr_block: '{{ vpc_cidr }}' + tags: + TestPrefix: '{{ resource_prefix }}' + register: vpc_result + + - name: create subnets + ec2_vpc_subnet: + state: present + cidr: '{{ item.cidr }}' + az: '{{ item.zone }}' + vpc_id: '{{ vpc_result.vpc.id }}' + tags: + Name: '{{ item.name }}' + TestPrefix: '{{ resource_prefix }}' + register: vpc_subnet_create + loop: + - name: '{{ subnet_name_a }}' + cidr: '{{ subnet_cidr_a }}' + zone: '{{ subnet_zone_a }}' + - name: '{{ subnet_name_b }}' + cidr: '{{ subnet_cidr_b }}' + zone: '{{ subnet_zone_b }}' + - name: '{{ subnet_name_c }}' + cidr: '{{ subnet_cidr_c }}' + zone: '{{ subnet_zone_c }}' + - name: '{{ subnet_name_d }}' + cidr: '{{ subnet_cidr_d }}' + zone: '{{ subnet_zone_d }}' + + - name: Store IDs of subnets and VPC + set_fact: + vpc_id: '{{ vpc_result.vpc.id }}' + subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' + subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' + subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' + subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' + + # ============================================================ + + - name: Create Subnet Group - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_default }}' + group_subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + check_mode: True + + - name: Check result - Create Subnet Group - check_mode + assert: + that: + - create_group is successful + - create_group is changed + + - name: Create Subnet Group + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_default }}' + group_subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + + - name: Check result - Create Subnet Group + assert: + that: + - create_group is successful + - create_group is changed + - '"group" in create_group' + - '"name" in create_group.group' + - '"vpc_id" in create_group.group' + - create_group.group.name == group_name + - create_group.group.vpc_id == vpc_id + - '"cluster_subnet_group" in create_group' + - '"description" in create_group.cluster_subnet_group' + - '"subnet_ids" in create_group.cluster_subnet_group' + - '"vpc_id" in create_group.cluster_subnet_group' + - create_group.cluster_subnet_group.name == group_name + - create_group.cluster_subnet_group.description == description_default + - subnet_id_a in create_group.cluster_subnet_group.subnet_ids + - subnet_id_b in create_group.cluster_subnet_group.subnet_ids + - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids + - create_group.cluster_subnet_group.vpc_id == vpc_id + + - name: Create Subnet Group - idempotency - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_default }}' + group_subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + check_mode: True + + - name: Check result - Create Subnet Group - idempotency - check_mode + assert: + that: + - create_group is successful + - create_group is not changed + + - name: Create Subnet Group - idempotency + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_default }}' + group_subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: create_group + + - name: Check result - Create Subnet Group - idempotency + assert: + that: + - create_group is successful + - create_group is not changed + - '"group" in create_group' + - '"name" in create_group.group' + - '"vpc_id" in create_group.group' + - create_group.group.name == group_name + - create_group.group.vpc_id == vpc_id + - '"cluster_subnet_group" in create_group' + - '"description" in create_group.cluster_subnet_group' + - '"subnet_ids" in create_group.cluster_subnet_group' + - '"vpc_id" in create_group.cluster_subnet_group' + - create_group.cluster_subnet_group.name == group_name + - create_group.cluster_subnet_group.description == description_default + - subnet_id_a in create_group.cluster_subnet_group.subnet_ids + - subnet_id_b in create_group.cluster_subnet_group.subnet_ids + - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids + - create_group.cluster_subnet_group.vpc_id == vpc_id + + # ============================================================ + + - name: Update Subnet Group Description - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_updated }}' + ## No longer mandatory + # group_subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + check_mode: True + + - name: Check result - Update Subnet Group Description - check_mode + assert: + that: + - update_description is successful + - update_description is changed + + - name: Update Subnet Group Description + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_updated }}' + ## No longer mandatory + # group_subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + + - name: Check result - Update Subnet Group Description + assert: + that: + - update_description is successful + - update_description is changed + - '"group" in update_description' + - '"name" in update_description.group' + - '"vpc_id" in update_description.group' + - update_description.group.name == group_name + - update_description.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_description' + - '"description" in update_description.cluster_subnet_group' + - '"subnet_ids" in update_description.cluster_subnet_group' + - '"vpc_id" in update_description.cluster_subnet_group' + - update_description.cluster_subnet_group.name == group_name + - update_description.cluster_subnet_group.description == description_updated + - subnet_id_a in update_description.cluster_subnet_group.subnet_ids + - subnet_id_b in update_description.cluster_subnet_group.subnet_ids + - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids + - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids + - update_description.cluster_subnet_group.vpc_id == vpc_id + + - name: Update Subnet Group Description - idempotency - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_updated }}' + ## No longer mandatory + # group_subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + check_mode: True + + - name: Check result - Update Subnet Group Description - idempotency - check_mode + assert: + that: + - update_description is successful + - update_description is not changed + + - name: Update Subnet Group Description - idempotency + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + group_description: '{{ description_updated }}' + ## No longer mandatory + # group_subnets: + # - '{{ subnet_id_a }}' + # - '{{ subnet_id_b }}' + register: update_description + + - name: Check result - Update Subnet Group Description - idempotency + assert: + that: + - update_description is successful + - update_description is not changed + - '"group" in update_description' + - '"name" in update_description.group' + - '"vpc_id" in update_description.group' + - update_description.group.name == group_name + - update_description.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_description' + - '"description" in update_description.cluster_subnet_group' + - '"subnet_ids" in update_description.cluster_subnet_group' + - '"vpc_id" in update_description.cluster_subnet_group' + - update_description.cluster_subnet_group.name == group_name + - update_description.cluster_subnet_group.description == description_updated + - subnet_id_a in update_description.cluster_subnet_group.subnet_ids + - subnet_id_b in update_description.cluster_subnet_group.subnet_ids + - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids + - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids + - update_description.cluster_subnet_group.vpc_id == vpc_id + + # ============================================================ + + - name: Update Subnet Group subnets - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + ## No longer mandatory + # group_description: '{{ description_updated }}' + group_subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + check_mode: True + + - name: Check result - Update Subnet Group subnets - check_mode + assert: + that: + - update_subnets is successful + - update_subnets is changed + + - name: Update Subnet Group subnets + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + ## No longer mandatory + # group_description: '{{ description_updated }}' + group_subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + + - name: Check result - Update Subnet Group subnets + assert: + that: + - update_subnets is successful + - update_subnets is changed + - '"group" in update_subnets' + - '"name" in update_subnets.group' + - '"vpc_id" in update_subnets.group' + - update_subnets.group.name == group_name + - update_subnets.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_subnets' + - '"description" in update_subnets.cluster_subnet_group' + - '"subnet_ids" in update_subnets.cluster_subnet_group' + - '"vpc_id" in update_subnets.cluster_subnet_group' + - update_subnets.cluster_subnet_group.name == group_name + - update_subnets.cluster_subnet_group.description == description_updated + - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids + - update_subnets.cluster_subnet_group.vpc_id == vpc_id + + - name: Update Subnet Group subnets - idempotency - check_mode + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + ## No longer mandatory + # group_description: '{{ description_updated }}' + group_subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + check_mode: True + + - name: Check result - Update Subnet Group subnets - idempotency - check_mode + assert: + that: + - update_subnets is successful + - update_subnets is not changed + + - name: Update Subnet Group subnets - idempotency + redshift_subnet_group: + state: present + group_name: '{{ group_name }}' + ## No longer mandatory + # group_description: '{{ description_updated }}' + group_subnets: + - '{{ subnet_id_c }}' + - '{{ subnet_id_d }}' + register: update_subnets + + - name: Check result - Update Subnet Group subnets - idempotency + assert: + that: + - update_subnets is successful + - update_subnets is not changed + - '"group" in update_subnets' + - '"name" in update_subnets.group' + - '"vpc_id" in update_subnets.group' + - update_subnets.group.name == group_name + - update_subnets.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_subnets' + - '"description" in update_subnets.cluster_subnet_group' + - '"subnet_ids" in update_subnets.cluster_subnet_group' + - '"vpc_id" in update_subnets.cluster_subnet_group' + - update_subnets.cluster_subnet_group.name == group_name + - update_subnets.cluster_subnet_group.description == description_updated + - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids + - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids + - update_subnets.cluster_subnet_group.vpc_id == vpc_id + + # ============================================================ + + - name: Delete Subnet Group - check_mode + redshift_subnet_group: + state: absent + group_name: '{{ group_name }}' + register: delete_group + check_mode: True + + - name: Check result - Delete Subnet Group - check_mode + assert: + that: + - delete_group is changed + + - name: Delete Subnet Group + redshift_subnet_group: + state: absent + group_name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group + assert: + that: + - delete_group is changed + + - name: Delete Subnet Group - idempotency - check_mode + redshift_subnet_group: + state: absent + group_name: '{{ group_name }}' + register: delete_group + check_mode: True + + - name: Check result - Delete Subnet Group - idempotency - check_mode + assert: + that: + - delete_group is not changed + + - name: Delete Subnet Group - idempotency + redshift_subnet_group: + state: absent + group_name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group - idempotency + assert: + that: + - delete_group is not changed + + # ============================================================ + + - name: Create minimal Subnet Group - check_mode + redshift_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + check_mode: True + + - name: Check result - Create minimal Subnet Group - check_mode + assert: + that: + - create_group is successful + - create_group is changed + + - name: Create minimal Subnet Group + redshift_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + + - name: Check result - Create minimal Subnet Group + assert: + that: + - create_group is successful + - create_group is changed + - '"group" in create_group' + - '"name" in create_group.group' + - '"vpc_id" in create_group.group' + - create_group.group.name == group_name + - create_group.group.vpc_id == vpc_id + - '"cluster_subnet_group" in create_group' + - '"description" in create_group.cluster_subnet_group' + - '"subnet_ids" in create_group.cluster_subnet_group' + - '"vpc_id" in create_group.cluster_subnet_group' + - create_group.cluster_subnet_group.name == group_name + - create_group.cluster_subnet_group.description == group_name + - subnet_id_a in create_group.cluster_subnet_group.subnet_ids + - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids + - create_group.cluster_subnet_group.vpc_id == vpc_id + + - name: Create minimal Subnet Group - idempotency - check_mode + redshift_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + check_mode: True + + - name: Check result - Create minimal Subnet Group - idempotency - check_mode + assert: + that: + - create_group is successful + - create_group is not changed + + - name: Create minimal Subnet Group - idempotency + redshift_subnet_group: + state: present + name: '{{ group_name }}' + subnets: + - '{{ subnet_id_a }}' + register: create_group + + - name: Check result - Create minimal Subnet Group - idempotency + assert: + that: + - create_group is successful + - create_group is not changed + - '"group" in create_group' + - '"name" in create_group.group' + - '"vpc_id" in create_group.group' + - create_group.group.name == group_name + - create_group.group.vpc_id == vpc_id + - '"cluster_subnet_group" in create_group' + - '"description" in create_group.cluster_subnet_group' + - '"subnet_ids" in create_group.cluster_subnet_group' + - '"vpc_id" in create_group.cluster_subnet_group' + - create_group.cluster_subnet_group.name == group_name + - create_group.cluster_subnet_group.description == group_name + - subnet_id_a in create_group.cluster_subnet_group.subnet_ids + - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids + - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids + - create_group.cluster_subnet_group.vpc_id == vpc_id + + # ============================================================ + + - name: Full Update Subnet Group - check_mode + redshift_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + check_mode: True + + - name: Check result - Full Update Subnet Group - check_mode + assert: + that: + - update_complex is successful + - update_complex is changed + + - name: Full Update Subnet Group + redshift_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + + - name: Check result - Full Update Subnet Group + assert: + that: + - update_complex is successful + - update_complex is changed + - '"group" in update_complex' + - '"name" in update_complex.group' + - '"vpc_id" in update_complex.group' + - update_complex.group.name == group_name + - update_complex.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_complex' + - '"description" in update_complex.cluster_subnet_group' + - '"subnet_ids" in update_complex.cluster_subnet_group' + - '"vpc_id" in update_complex.cluster_subnet_group' + - update_complex.cluster_subnet_group.name == group_name + - update_complex.cluster_subnet_group.description == description_updated + - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids + - update_complex.cluster_subnet_group.vpc_id == vpc_id + + - name: Full Update Subnet Group - idempotency - check_mode + redshift_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + check_mode: True + + - name: Check result - Full Update Subnet Group - idempotency - check_mode + assert: + that: + - update_complex is successful + - update_complex is not changed + + - name: Full Update Subnet Group - idempotency + redshift_subnet_group: + state: present + name: '{{ group_name }}' + description: '{{ description_updated }}' + subnets: + - '{{ subnet_id_a }}' + - '{{ subnet_id_b }}' + register: update_complex + + - name: Check result - Full Update Subnet Group - idempotency + assert: + that: + - update_complex is successful + - update_complex is not changed + - '"group" in update_complex' + - '"name" in update_complex.group' + - '"vpc_id" in update_complex.group' + - update_complex.group.name == group_name + - update_complex.group.vpc_id == vpc_id + - '"cluster_subnet_group" in update_complex' + - '"description" in update_complex.cluster_subnet_group' + - '"subnet_ids" in update_complex.cluster_subnet_group' + - '"vpc_id" in update_complex.cluster_subnet_group' + - update_complex.cluster_subnet_group.name == group_name + - update_complex.cluster_subnet_group.description == description_updated + - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids + - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids + - update_complex.cluster_subnet_group.vpc_id == vpc_id + + # ============================================================ + + - name: Delete Subnet Group + redshift_subnet_group: + state: absent + name: '{{ group_name }}' + register: delete_group + + - name: Check result - Delete Subnet Group + assert: + that: + - delete_group is changed + + always: + + ################################################ + # TEARDOWN STARTS HERE + ################################################ + + - name: Delete Subnet Group + redshift_subnet_group: + state: absent + group_name: '{{ group_name }}' + ignore_errors: True + + - name: tidy up subnet + ec2_vpc_subnet: + state: absent + cidr: '{{ item }}' + vpc_id: '{{ vpc_result.vpc.id }}' + loop: + - '{{ subnet_cidr_a }}' + - '{{ subnet_cidr_b }}' + - '{{ subnet_cidr_c }}' + - '{{ subnet_cidr_d }}' + ignore_errors: True + + - name: tidy up VPC + ec2_vpc_net: + state: absent + name: '{{ vpc_name }}' + cidr_block: '{{ vpc_cidr }}' + ignore_errors: True diff --git a/tests/integration/targets/route53/tasks/main.yml b/tests/integration/targets/route53/tasks/main.yml index 18f10ae2987..ae80586dbe8 100644 --- a/tests/integration/targets/route53/tasks/main.yml +++ b/tests/integration/targets/route53/tasks/main.yml @@ -503,6 +503,42 @@ - alias_record is not failed - alias_record is not changed + - name: 'Create a weighted record' + route53: + state: present + zone: '{{ zone_one }}' + record: 'weighted.{{ zone_one }}' + type: CNAME + value: 'zid_test.{{ zone_one }}' + overwrite: True + identifier: "host1@www" + weight: 100 + region: '{{ omit }}' + register: weighted_record + - name: 'This should be changed' + assert: + that: + - weighted_record is not failed + - weighted_record is changed + + - name: 'Re-Create a weighted record' + route53: + state: present + zone: '{{ zone_one }}' + record: 'weighted.{{ zone_one }}' + type: CNAME + value: 'zid_test.{{ zone_one }}' + overwrite: True + identifier: "host1@www" + weight: 100 + region: '{{ omit }}' + register: weighted_record + - name: 'This should not be changed' + assert: + that: + - weighted_record is not failed + - weighted_record is not changed + always: - route53_info: query: record_sets @@ -521,6 +557,20 @@ loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' + - name: 'Loop over A/AAAA/CNAME records and delete them' + route53: + state: absent + zone: '{{ zone_one }}' + record: '{{ item.Name }}' + type: '{{ item.Type }}' + value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' + identifier: '{{ item.SetIdentifier }}' + region: '{{ omit }}' + ignore_errors: True + loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' + when: + - '"ResourceRecords" in item' + - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent @@ -551,6 +601,21 @@ loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' + - name: 'Loop over A/AAAA/CNAME records and delete them' + route53: + state: absent + zone: '{{ zone_two }}' + record: '{{ item.Name }}' + type: '{{ item.Type }}' + value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' + identifier: '{{ item.SetIdentifier }}' + region: '{{ omit }}' + private_zone: true + ignore_errors: True + loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' + when: + - '"ResourceRecords" in item' + - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent diff --git a/tests/integration/targets/setup_botocore_pip/defaults/main.yml b/tests/integration/targets/setup_botocore_pip/defaults/main.yml new file mode 100644 index 00000000000..5a50b775907 --- /dev/null +++ b/tests/integration/targets/setup_botocore_pip/defaults/main.yml @@ -0,0 +1,2 @@ +default_botocore_version: '1.18.0' +default_boto3_version: '1.15.0' diff --git a/tests/integration/targets/setup_botocore_pip/handlers/main.yml b/tests/integration/targets/setup_botocore_pip/handlers/main.yml new file mode 100644 index 00000000000..2536d1ac773 --- /dev/null +++ b/tests/integration/targets/setup_botocore_pip/handlers/main.yml @@ -0,0 +1,2 @@ +- name: 'Delete temporary pip environment' + include_tasks: cleanup.yml diff --git a/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml b/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml new file mode 100644 index 00000000000..25b3ec27efc --- /dev/null +++ b/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml @@ -0,0 +1,5 @@ +- name: 'Delete temporary pip environment' + file: + path: "{{ botocore_pip_directory }}" + state: absent + no_log: yes diff --git a/tests/integration/targets/setup_botocore_pip/tasks/main.yml b/tests/integration/targets/setup_botocore_pip/tasks/main.yml new file mode 100644 index 00000000000..b183b7d726d --- /dev/null +++ b/tests/integration/targets/setup_botocore_pip/tasks/main.yml @@ -0,0 +1,42 @@ +- name: 'Ensure that we have virtualenv available to us' + pip: + name: virtualenv + +- name: 'Create temporary directory for pip environment' + tempfile: + state: directory + prefix: botocore + suffix: .test + register: botocore_pip_directory + notify: + - 'Delete temporary pip environment' + +- name: 'Record temporary directory' + set_fact: + botocore_pip_directory: "{{ botocore_pip_directory.path }}" + +- set_fact: + botocore_virtualenv: "{{ botocore_pip_directory }}/virtualenv" + botocore_virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" + +- set_fact: + botocore_virtualenv_interpreter: "{{ botocore_virtualenv }}/bin/python" + +- pip: + name: + - 'boto3{{ _boto3_comparison }}{{ _boto3_version }}' + - 'botocore{{ _botocore_comparison }}{{ _botocore_version }}' + - 'coverage<5' + virtualenv: "{{ botocore_virtualenv }}" + virtualenv_command: "{{ botocore_virtualenv_command }}" + virtualenv_site_packages: no + vars: + _boto3_version: '{{ boto3_version | default(default_boto3_version) }}' + _botocore_version: '{{ botocore_version | default(default_botocore_version) }}' + _is_default_boto3: '{{ _boto3_version == default_boto3_version }}' + _is_default_botocore: '{{ _botocore_version == default_botocore_version }}' + # Only set the default to >= if the other dep has been updated and the dep has not been set + _default_boto3_comparison: '{% if _is_default_boto3 and not _is_default_botocore %}>={% else %}=={% endif %}' + _default_botocore_comparison: '{% if _is_default_botocore and not _is_default_boto3 %}>={% else %}=={% endif %}' + _boto3_comparison: '{{ boto3_comparison | default(_default_boto3_comparison) }}' + _botocore_comparison: '{{ botocore_comparison | default(_default_botocore_comparison) }}' diff --git a/tests/integration/targets/setup_ec2_facts/defaults/main.yml b/tests/integration/targets/setup_ec2_facts/defaults/main.yml new file mode 100644 index 00000000000..a09e9a53707 --- /dev/null +++ b/tests/integration/targets/setup_ec2_facts/defaults/main.yml @@ -0,0 +1,3 @@ +ec2_ami_name: 'Fedora-Cloud-Base-*.x86_64*' +ec2_ami_owner_id: '125523088429' +ec2_ami_ssh_user: 'fedora' diff --git a/tests/integration/targets/setup_ec2_facts/tasks/main.yml b/tests/integration/targets/setup_ec2_facts/tasks/main.yml new file mode 100644 index 00000000000..f41791073a3 --- /dev/null +++ b/tests/integration/targets/setup_ec2_facts/tasks/main.yml @@ -0,0 +1,53 @@ +--- +# Setup a couple of common facts about the AWS Region +# +# Information about availablity zones +# - ec2_availability_zone_names +# +# An EC2 AMI that can be used for spinning up Instances performs as search +# rather than hardcoding the IDs so we're not limited to specific Regions +# - ec2_ami_id +# +- module_defaults: + group/aws: + aws_access_key: '{{ aws_access_key }}' + aws_secret_key: '{{ aws_secret_key }}' + security_token: '{{ security_token | default(omit) }}' + region: '{{ aws_region }}' + + run_once: True + block: + # ============================================================ + + - name: Get available AZs + aws_az_info: + filters: + region-name: '{{ aws_region }}' + register: _az_info + + - name: Pick an AZ + set_fact: + ec2_availability_zone_names: '{{ _az_info.availability_zones | selectattr("zone_name", "defined") | map(attribute="zone_name") | list }}' + + # ============================================================ + + - name: Get a list of images + ec2_ami_info: + filters: + name: '{{ ec2_ami_name }}' + owner-id: '{{ ec2_ami_owner_id }}' + architecture: x86_64 + virtualization-type: hvm + root-device-type: ebs + register: _images_info + # Very spammy + no_log: True + + - name: Set Fact for latest AMI + vars: + latest_image: '{{ _images_info.images | sort(attribute="creation_date") | reverse | first }}' + set_fact: + ec2_ami_id: '{{ latest_image.image_id }}' + ec2_ami_details: '{{ latest_image }}' + ec2_ami_root_disk: '{{ latest_image.block_device_mappings[0].device_name }}' + ec2_ami_ssh_user: '{{ ec2_ami_ssh_user }}' diff --git a/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py b/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py new file mode 100644 index 00000000000..ea2f51b0f4c --- /dev/null +++ b/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python +""" +Reads an OpenSSH Public key and spits out the 'AWS' MD5 sum +The equivalent of + +ssh-keygen -f id_rsa.pub -e -m PKCS8 | openssl pkey -pubin -outform DER | openssl md5 -c | cut -f 2 -d ' ' + +(but without needing the OpenSSL CLI) +""" + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + +import hashlib +import sys +from Crypto.PublicKey import RSA + +if len(sys.argv) == 0: + ssh_public_key = "id_rsa.pub" +else: + ssh_public_key = sys.argv[1] + +with open(ssh_public_key, 'r') as key_fh: + data = key_fh.read() + +# Convert from SSH format to DER format +public_key = RSA.importKey(data).exportKey('DER') +md5digest = hashlib.md5(public_key).hexdigest() +# Format the md5sum into the normal format +pairs = zip(md5digest[::2], md5digest[1::2]) +md5string = ":".join(["".join(pair) for pair in pairs]) + +print(md5string) diff --git a/tests/integration/targets/setup_sshkey/tasks/main.yml b/tests/integration/targets/setup_sshkey/tasks/main.yml new file mode 100644 index 00000000000..31bd2176e5c --- /dev/null +++ b/tests/integration/targets/setup_sshkey/tasks/main.yml @@ -0,0 +1,71 @@ +# (c) 2014, James Laska + +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +- name: create a temp dir + tempfile: + state: directory + register: sshkey_dir + tags: + - prepare + +- name: ensure script is available + copy: + src: ec2-fingerprint.py + dest: '{{ sshkey_dir.path }}/ec2-fingerprint.py' + mode: 0700 + tags: + - prepare + +- name: Set location of SSH keys + set_fact: + sshkey: '{{ sshkey_dir.path }}/key_one' + another_sshkey: '{{ sshkey_dir.path }}/key_two' + sshkey_pub: '{{ sshkey_dir.path }}/key_one.pub' + another_sshkey_pub: '{{ sshkey_dir.path }}/key_two.pub' + +- name: generate sshkey + shell: echo 'y' | ssh-keygen -P '' -f '{{ sshkey }}' + tags: + - prepare + +- name: record fingerprint + shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ sshkey_pub }}' + register: fingerprint + tags: + - prepare + +- name: generate another_sshkey + shell: echo 'y' | ssh-keygen -P '' -f {{ another_sshkey }} + tags: + - prepare + +- name: record another fingerprint + shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ another_sshkey_pub }}' + register: another_fingerprint + tags: + - prepare + +- name: set facts for future roles + set_fact: + # Public SSH keys (OpenSSH format) + key_material: "{{ lookup('file', sshkey_pub) }}" + another_key_material: "{{ lookup('file', another_sshkey_pub) }}" + # AWS 'fingerprint' (md5digest) + fingerprint: '{{ fingerprint.stdout }}' + another_fingerprint: '{{ another_fingerprint.stdout }}' + tags: + - prepare diff --git a/tests/integration/targets/sns_topic/tasks/main.yml b/tests/integration/targets/sns_topic/tasks/main.yml index 891b162e4d2..94214b20fa9 100644 --- a/tests/integration/targets/sns_topic/tasks/main.yml +++ b/tests/integration/targets/sns_topic/tasks/main.yml @@ -127,7 +127,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: 20 + minDelayTarget: "20" maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -153,7 +153,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: 20 + minDelayTarget: "20" maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -179,7 +179,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: 40 + minDelayTarget: "40" maxDelayTarget: 40 numRetries: 6 numMaxDelayRetries: 0 diff --git a/tests/requirements.yml b/tests/requirements.yml index 27240dbf096..3480da42122 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 1.5.0 +- amazon.aws >= 2.0.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 1.5.0 +- amazon.aws >= 2.0.0 diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt new file mode 100644 index 00000000000..e5bade76474 --- /dev/null +++ b/tests/sanity/ignore-2.13.txt @@ -0,0 +1,3 @@ +plugins/modules/cloudfront_info.py pylint:unnecessary-comprehension # (new test) Should be an easy fix, but testing is a challenge - test are broken and aliases require a wildcard cert in ACM +plugins/modules/iam.py pylint:unnecessary-comprehension # no tests and module is deprecated +plugins/modules/route53.py validate-modules:parameter-state-invalid-choice # route53_info needs improvements before we can deprecate this diff --git a/tests/unit/constraints.txt b/tests/unit/constraints.txt new file mode 100644 index 00000000000..bd95eb26733 --- /dev/null +++ b/tests/unit/constraints.txt @@ -0,0 +1,7 @@ +# Specifically run tests against the oldest versions that we support +boto3==1.15.0 +botocore==1.18.0 + +# AWS CLI has `botocore==` dependencies, provide the one that matches botocore +# to avoid needing to download over a years worth of awscli wheels. +awscli==1.18.141 diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt index 4b10ff777a4..704c73a25b2 100644 --- a/tests/unit/requirements.txt +++ b/tests/unit/requirements.txt @@ -1,3 +1,6 @@ +# Our code is based on the AWS SDKs +botocore +boto3 +boto + placebo -botocore>=1.16.0 -boto3>=1.13.0 From 8a1577bd7429465fb289073850761ceac009faca Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 8 Oct 2021 09:34:08 +0100 Subject: [PATCH 15/29] Revert "Squashed commit of the following:" This reverts commit 8d9aacc5c9655dea2483c08dc37948486fe94cbe. --- CHANGELOG.rst | 120 -- README.md | 16 +- bindep.txt | 4 - changelogs/changelog.yaml | 219 ---- changelogs/fragments/0-copy_ignore_txt.yml | 3 - ...-elb-module-add-ip_address_type_option.yml | 4 + ..._instance-preferred_maintenance_window.yml | 2 + changelogs/fragments/564-route53-retries.yml | 6 + .../574-ecs_taskdefinition-improvement.yml | 3 + changelogs/fragments/586-elb-renames.yml | 8 + .../fragments/592-sqs_queue-idempotent.yml | 2 + .../fragments/595-fix-route53-identifer.yaml | 2 - ...s-task-defination-env-file-validations.yml | 2 + .../fragments/614-ec2_vpc_peer-tagging.yml | 4 + .../616-ec2_vpc_route_table-tagging.yml | 4 + changelogs/fragments/629-imports-cleanup.yml | 2 + changelogs/fragments/648-kms_info.yml | 4 + changelogs/fragments/659-checkmode.yml | 10 + changelogs/fragments/663-deprecate-rds.yml | 3 + changelogs/fragments/664-deprecate-iam.yml | 3 + .../670-elb_target_group-new_attriibutes.yml | 3 - changelogs/fragments/675-boto3-minimums.yml | 26 + .../681-aws_secret-deletion-idempotency.yml | 2 + .../682-aws_s3_bucket_info-botocore.yml | 2 + changelogs/fragments/686-pylint.yml | 4 + changelogs/fragments/688-pylint.yml | 10 + .../692-s3_sync-individual-file-path.yml | 2 + ...-UpdateRoleDescription-with-UpdateRole.yml | 2 + ...d-cloudfront-new-security-policy-2021.yaml | 2 - .../724-redshift_subnet_group-boto3.yml | 7 - changelogs/fragments/728-iam_cert.yml | 3 - .../fragments/731-ec2_eip-not_in_vpc.yml | 2 - .../735-iam_server_certificate-file-names.yml | 3 - .../739-sns_topic-delivery_policy-shape.yml | 2 - .../fragments/deprecate_ec2_inv_script.yml | 2 + changelogs/fragments/migrate_ec2_instance.yml | 3 + .../fragments/migrate_ec2_vpc_endpoint.yml | 13 + changelogs/fragments/migrate_ec2_vpc_igw.yml | 10 + .../fragments/migrate_ec2_vpc_nat_gateway.yml | 10 + .../fragments/rename-connection-retries.yml | 2 + changelogs/fragments/sns_topic_type.yml | 2 + docs/community.aws.aws_acm_info_module.rst | 24 +- docs/community.aws.aws_acm_module.rst | 24 +- docs/community.aws.aws_api_gateway_module.rst | 24 +- ....aws_application_scaling_policy_module.rst | 26 +- ...s.aws_batch_compute_environment_module.rst | 24 +- ...ty.aws.aws_batch_job_definition_module.rst | 24 +- ...mmunity.aws.aws_batch_job_queue_module.rst | 24 +- docs/community.aws.aws_codebuild_module.rst | 25 +- docs/community.aws.aws_codecommit_module.rst | 25 +- .../community.aws.aws_codepipeline_module.rst | 25 +- ...onfig_aggregation_authorization_module.rst | 25 +- ...unity.aws.aws_config_aggregator_module.rst | 25 +- ...aws.aws_config_delivery_channel_module.rst | 25 +- ...mmunity.aws.aws_config_recorder_module.rst | 25 +- docs/community.aws.aws_config_rule_module.rst | 25 +- ...rect_connect_confirm_connection_module.rst | 25 +- ...s.aws_direct_connect_connection_module.rst | 25 +- ....aws.aws_direct_connect_gateway_module.rst | 24 +- ..._connect_link_aggregation_group_module.rst | 25 +- ...irect_connect_virtual_interface_module.rst | 25 +- docs/community.aws.aws_eks_cluster_module.rst | 25 +- ...ty.aws.aws_elasticbeanstalk_app_module.rst | 23 +- ...mmunity.aws.aws_glue_connection_module.rst | 24 +- docs/community.aws.aws_glue_job_module.rst | 24 +- ...munity.aws.aws_inspector_target_module.rst | 25 +- docs/community.aws.aws_kms_info_module.rst | 47 +- docs/community.aws.aws_kms_module.rst | 23 +- docs/community.aws.aws_msk_cluster_module.rst | 1031 ----------------- docs/community.aws.aws_msk_config_module.rst | 435 ------- docs/community.aws.aws_region_info_module.rst | 25 +- ...ommunity.aws.aws_s3_bucket_info_module.rst | 25 +- docs/community.aws.aws_s3_cors_module.rst | 23 +- docs/community.aws.aws_secret_module.rst | 25 +- .../community.aws.aws_ses_identity_module.rst | 25 +- ...ity.aws.aws_ses_identity_policy_module.rst | 25 +- .../community.aws.aws_ses_rule_set_module.rst | 25 +- docs/community.aws.aws_sgw_info_module.rst | 24 +- docs/community.aws.aws_ssm_connection.rst | 20 +- ...ity.aws.aws_ssm_parameter_store_module.rst | 25 +- ...nctions_state_machine_execution_module.rst | 23 +- ...ws_step_functions_state_machine_module.rst | 23 +- ...community.aws.aws_waf_condition_module.rst | 23 +- docs/community.aws.aws_waf_info_module.rst | 24 +- docs/community.aws.aws_waf_rule_module.rst | 23 +- docs/community.aws.aws_waf_web_acl_module.rst | 23 +- ...aws.cloudformation_exports_info_module.rst | 24 +- ...ty.aws.cloudformation_stack_set_module.rst | 25 +- ...ity.aws.cloudfront_distribution_module.rst | 98 +- docs/community.aws.cloudfront_info_module.rst | 24 +- ...ity.aws.cloudfront_invalidation_module.rst | 24 +- ...oudfront_origin_access_identity_module.rst | 24 +- docs/community.aws.cloudtrail_module.rst | 25 +- ...munity.aws.cloudwatchevent_rule_module.rst | 24 +- ...s.cloudwatchlogs_log_group_info_module.rst | 25 +- ...tchlogs_log_group_metric_filter_module.rst | 25 +- ...ty.aws.cloudwatchlogs_log_group_module.rst | 26 +- docs/community.aws.data_pipeline_module.rst | 24 +- docs/community.aws.dms_endpoint_module.rst | 23 +- ...ws.dms_replication_subnet_group_module.rst | 23 +- docs/community.aws.dynamodb_table_module.rst | 26 +- docs/community.aws.dynamodb_ttl_module.rst | 28 +- docs/community.aws.ec2_ami_copy_module.rst | 24 +- docs/community.aws.ec2_asg_info_module.rst | 24 +- ...nity.aws.ec2_asg_lifecycle_hook_module.rst | 24 +- docs/community.aws.ec2_asg_module.rst | 25 +- ...y.aws.ec2_customer_gateway_info_module.rst | 24 +- ...munity.aws.ec2_customer_gateway_module.rst | 25 +- docs/community.aws.ec2_eip_info_module.rst | 23 +- docs/community.aws.ec2_eip_module.rst | 23 +- docs/community.aws.ec2_elb_info_module.rst | 35 +- ...e.rst => community.aws.ec2_elb_module.rst} | 229 ++-- ...mmunity.aws.ec2_launch_template_module.rst | 27 +- docs/community.aws.ec2_lc_find_module.rst | 24 +- docs/community.aws.ec2_lc_info_module.rst | 24 +- docs/community.aws.ec2_lc_module.rst | 24 +- .../community.aws.ec2_metric_alarm_module.rst | 23 +- ...ty.aws.ec2_placement_group_info_module.rst | 23 +- ...mmunity.aws.ec2_placement_group_module.rst | 23 +- ...ommunity.aws.ec2_scaling_policy_module.rst | 23 +- ...community.aws.ec2_snapshot_copy_module.rst | 24 +- ...ty.aws.ec2_transit_gateway_info_module.rst | 25 +- ...mmunity.aws.ec2_transit_gateway_module.rst | 25 +- ...ommunity.aws.ec2_vpc_egress_igw_module.rst | 23 +- ...community.aws.ec2_vpc_nacl_info_module.rst | 24 +- docs/community.aws.ec2_vpc_nacl_module.rst | 26 +- docs/community.aws.ec2_vpc_peer_module.rst | 46 +- ...munity.aws.ec2_vpc_peering_info_module.rst | 24 +- ...ty.aws.ec2_vpc_route_table_info_module.rst | 23 +- ...mmunity.aws.ec2_vpc_route_table_module.rst | 23 +- .../community.aws.ec2_vpc_vgw_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vgw_module.rst | 24 +- .../community.aws.ec2_vpc_vpn_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vpn_module.rst | 25 +- .../community.aws.ec2_win_password_module.rst | 24 +- docs/community.aws.ecs_attribute_module.rst | 25 +- docs/community.aws.ecs_cluster_module.rst | 24 +- docs/community.aws.ecs_ecr_module.rst | 25 +- .../community.aws.ecs_service_info_module.rst | 26 +- docs/community.aws.ecs_service_module.rst | 29 +- docs/community.aws.ecs_tag_module.rst | 25 +- docs/community.aws.ecs_task_module.rst | 27 +- ...ity.aws.ecs_taskdefinition_info_module.rst | 26 +- ...ommunity.aws.ecs_taskdefinition_module.rst | 43 +- docs/community.aws.efs_info_module.rst | 28 +- docs/community.aws.efs_module.rst | 26 +- .../community.aws.elasticache_info_module.rst | 23 +- docs/community.aws.elasticache_module.rst | 24 +- ...aws.elasticache_parameter_group_module.rst | 25 +- ...munity.aws.elasticache_snapshot_module.rst | 25 +- ...ty.aws.elasticache_subnet_group_module.rst | 155 +-- ...ity.aws.elb_application_lb_info_module.rst | 60 +- ...ommunity.aws.elb_application_lb_module.rst | 43 +- ...mmunity.aws.elb_classic_lb_info_module.rst | 25 +- docs/community.aws.elb_classic_lb_module.rst | 843 ++++++++++++++ docs/community.aws.elb_instance_module.rst | 37 +- docs/community.aws.elb_network_lb_module.rst | 43 +- ...unity.aws.elb_target_group_info_module.rst | 24 +- .../community.aws.elb_target_group_module.rst | 24 +- docs/community.aws.elb_target_info_module.rst | 25 +- docs/community.aws.elb_target_module.rst | 23 +- docs/community.aws.execute_lambda_module.rst | 24 +- docs/community.aws.iam_cert_module.rst | 24 +- docs/community.aws.iam_group_module.rst | 25 +- ...ommunity.aws.iam_managed_policy_module.rst | 25 +- ...mmunity.aws.iam_mfa_device_info_module.rst | 25 +- docs/community.aws.iam_module.rst | 35 +- ...mmunity.aws.iam_password_policy_module.rst | 25 +- docs/community.aws.iam_policy_info_module.rst | 23 +- docs/community.aws.iam_policy_module.rst | 23 +- docs/community.aws.iam_role_info_module.rst | 24 +- docs/community.aws.iam_role_module.rst | 27 +- ...mmunity.aws.iam_saml_federation_module.rst | 24 +- ...aws.iam_server_certificate_info_module.rst | 25 +- docs/community.aws.iam_user_info_module.rst | 25 +- docs/community.aws.iam_user_module.rst | 25 +- docs/community.aws.kinesis_stream_module.rst | 24 +- docs/community.aws.lambda_alias_module.rst | 24 +- docs/community.aws.lambda_event_module.rst | 24 +- docs/community.aws.lambda_facts_module.rst | 24 +- docs/community.aws.lambda_info_module.rst | 24 +- docs/community.aws.lambda_module.rst | 26 +- docs/community.aws.lambda_policy_module.rst | 24 +- docs/community.aws.lightsail_module.rst | 24 +- ...community.aws.rds_instance_info_module.rst | 25 +- docs/community.aws.rds_instance_module.rst | 25 +- docs/community.aws.rds_module.rst | 38 +- docs/community.aws.rds_param_group_module.rst | 24 +- ...community.aws.rds_snapshot_info_module.rst | 24 +- docs/community.aws.rds_snapshot_module.rst | 24 +- .../community.aws.rds_subnet_group_module.rst | 23 +- ...redshift_cross_region_snapshots_module.rst | 25 +- docs/community.aws.redshift_info_module.rst | 24 +- docs/community.aws.redshift_module.rst | 24 +- ...unity.aws.redshift_subnet_group_module.rst | 26 +- ...munity.aws.route53_health_check_module.rst | 24 +- docs/community.aws.route53_info_module.rst | 23 +- docs/community.aws.route53_module.rst | 25 +- docs/community.aws.route53_zone_module.rst | 24 +- ...nity.aws.s3_bucket_notification_module.rst | 24 +- docs/community.aws.s3_lifecycle_module.rst | 23 +- docs/community.aws.s3_logging_module.rst | 23 +- ...ty.aws.s3_metrics_configuration_module.rst | 23 +- docs/community.aws.s3_sync_module.rst | 31 +- docs/community.aws.s3_website_module.rst | 24 +- docs/community.aws.sns_module.rst | 25 +- docs/community.aws.sns_topic_module.rst | 43 +- docs/community.aws.sqs_queue_module.rst | 26 +- docs/community.aws.sts_assume_role_module.rst | 25 +- ...community.aws.sts_session_token_module.rst | 25 +- ...community.aws.wafv2_ip_set_info_module.rst | 25 +- docs/community.aws.wafv2_ip_set_module.rst | 25 +- ...munity.aws.wafv2_resources_info_module.rst | 25 +- docs/community.aws.wafv2_resources_module.rst | 25 +- ...unity.aws.wafv2_rule_group_info_module.rst | 25 +- .../community.aws.wafv2_rule_group_module.rst | 25 +- ...ommunity.aws.wafv2_web_acl_info_module.rst | 25 +- docs/community.aws.wafv2_web_acl_module.rst | 25 +- galaxy.yml | 4 +- meta/runtime.yml | 11 +- plugins/modules/aws_msk_cluster.py | 1 + plugins/modules/aws_msk_config.py | 3 + plugins/modules/cloudfront_distribution.py | 3 +- plugins/modules/dynamodb_table.py | 4 +- plugins/modules/ec2_eip.py | 5 +- plugins/modules/elasticache_subnet_group.py | 248 ++-- plugins/modules/elb_target_group.py | 28 - ...{iam_server_certificate.py => iam_cert.py} | 37 +- plugins/modules/rds_instance_info.py | 5 - plugins/modules/redshift_subnet_group.py | 281 ++--- plugins/modules/route53.py | 1 - plugins/modules/sns_topic.py | 105 +- requirements.txt | 9 +- test-requirements.txt | 6 - tests/config.yml | 2 - tests/integration/constraints.txt | 8 +- tests/integration/requirements.txt | 11 +- .../targets/aws_msk_cluster/tasks/main.yml | 72 +- .../targets/aws_msk_config/tasks/main.yml | 295 ++--- .../tasks/bucket_ownership_controls.yml | 2 +- .../targets/dynamodb_table/aliases | 1 - .../targets/dynamodb_table/defaults/main.yml | 47 - .../targets/dynamodb_table/meta/main.yml | 2 - .../targets/dynamodb_table/tasks/main.yml | 733 ------------ .../targets/ec2_eip/tasks/main.yml | 25 - tests/integration/targets/elasticache/aliases | 2 + .../targets/elasticache_subnet_group/aliases | 1 - .../defaults/main.yml | 42 - .../elasticache_subnet_group/meta/main.yml | 3 - .../elasticache_subnet_group/tasks/main.yml | 681 ----------- .../targets/elb_target/tasks/ec2_target.yml | 160 +-- .../targets/iam_server_certificate/aliases | 3 - .../iam_server_certificate/defaults/main.yml | 1 - .../iam_server_certificate/meta/main.yml | 3 - .../iam_server_certificate/tasks/main.yml | 34 - .../targets/redshift_subnet_group/aliases | 1 - .../redshift_subnet_group/defaults/main.yml | 42 - .../redshift_subnet_group/meta/main.yml | 3 - .../redshift_subnet_group/tasks/main.yml | 692 ----------- .../targets/route53/tasks/main.yml | 65 -- .../setup_botocore_pip/defaults/main.yml | 2 - .../setup_botocore_pip/handlers/main.yml | 2 - .../setup_botocore_pip/tasks/cleanup.yml | 5 - .../targets/setup_botocore_pip/tasks/main.yml | 42 - .../targets/setup_ec2_facts/defaults/main.yml | 3 - .../targets/setup_ec2_facts/tasks/main.yml | 53 - .../setup_sshkey/files/ec2-fingerprint.py | 33 - .../targets/setup_sshkey/tasks/main.yml | 71 -- .../targets/sns_topic/tasks/main.yml | 6 +- tests/requirements.yml | 4 +- tests/sanity/ignore-2.13.txt | 3 - tests/unit/constraints.txt | 7 - tests/unit/requirements.txt | 7 +- 273 files changed, 3665 insertions(+), 7965 deletions(-) delete mode 100644 bindep.txt delete mode 100644 changelogs/fragments/0-copy_ignore_txt.yml create mode 100644 changelogs/fragments/499-elb-module-add-ip_address_type_option.yml create mode 100644 changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml create mode 100644 changelogs/fragments/564-route53-retries.yml create mode 100644 changelogs/fragments/574-ecs_taskdefinition-improvement.yml create mode 100644 changelogs/fragments/586-elb-renames.yml create mode 100644 changelogs/fragments/592-sqs_queue-idempotent.yml delete mode 100644 changelogs/fragments/595-fix-route53-identifer.yaml create mode 100644 changelogs/fragments/600-ecs-task-defination-env-file-validations.yml create mode 100644 changelogs/fragments/614-ec2_vpc_peer-tagging.yml create mode 100644 changelogs/fragments/616-ec2_vpc_route_table-tagging.yml create mode 100644 changelogs/fragments/629-imports-cleanup.yml create mode 100644 changelogs/fragments/648-kms_info.yml create mode 100644 changelogs/fragments/659-checkmode.yml create mode 100644 changelogs/fragments/663-deprecate-rds.yml create mode 100644 changelogs/fragments/664-deprecate-iam.yml delete mode 100644 changelogs/fragments/670-elb_target_group-new_attriibutes.yml create mode 100644 changelogs/fragments/675-boto3-minimums.yml create mode 100644 changelogs/fragments/681-aws_secret-deletion-idempotency.yml create mode 100644 changelogs/fragments/682-aws_s3_bucket_info-botocore.yml create mode 100644 changelogs/fragments/686-pylint.yml create mode 100644 changelogs/fragments/688-pylint.yml create mode 100644 changelogs/fragments/692-s3_sync-individual-file-path.yml create mode 100644 changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml delete mode 100644 changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml delete mode 100644 changelogs/fragments/724-redshift_subnet_group-boto3.yml delete mode 100644 changelogs/fragments/728-iam_cert.yml delete mode 100644 changelogs/fragments/731-ec2_eip-not_in_vpc.yml delete mode 100644 changelogs/fragments/735-iam_server_certificate-file-names.yml delete mode 100644 changelogs/fragments/739-sns_topic-delivery_policy-shape.yml create mode 100644 changelogs/fragments/deprecate_ec2_inv_script.yml create mode 100644 changelogs/fragments/migrate_ec2_instance.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_endpoint.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_igw.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml create mode 100644 changelogs/fragments/rename-connection-retries.yml create mode 100644 changelogs/fragments/sns_topic_type.yml delete mode 100644 docs/community.aws.aws_msk_cluster_module.rst delete mode 100644 docs/community.aws.aws_msk_config_module.rst rename docs/{community.aws.efs_tag_module.rst => community.aws.ec2_elb_module.rst} (72%) create mode 100644 docs/community.aws.elb_classic_lb_module.rst rename plugins/modules/{iam_server_certificate.py => iam_cert.py} (88%) delete mode 100644 tests/config.yml delete mode 100644 tests/integration/targets/dynamodb_table/aliases delete mode 100644 tests/integration/targets/dynamodb_table/defaults/main.yml delete mode 100644 tests/integration/targets/dynamodb_table/meta/main.yml delete mode 100644 tests/integration/targets/dynamodb_table/tasks/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/aliases delete mode 100644 tests/integration/targets/elasticache_subnet_group/defaults/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/meta/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/tasks/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/aliases delete mode 100644 tests/integration/targets/iam_server_certificate/defaults/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/meta/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/tasks/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/aliases delete mode 100644 tests/integration/targets/redshift_subnet_group/defaults/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/meta/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/tasks/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/defaults/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/handlers/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/tasks/main.yml delete mode 100644 tests/integration/targets/setup_ec2_facts/defaults/main.yml delete mode 100644 tests/integration/targets/setup_ec2_facts/tasks/main.yml delete mode 100644 tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py delete mode 100644 tests/integration/targets/setup_sshkey/tasks/main.yml delete mode 100644 tests/sanity/ignore-2.13.txt delete mode 100644 tests/unit/constraints.txt diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3c330f1d0f6..3a5c31399fd 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,126 +5,6 @@ community.aws Release Notes .. contents:: Topics -v2.0.0 -====== - -Major Changes -------------- - -- community.aws collection - The community.aws collection has dropped support for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). - -Minor Changes -------------- - -- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) -- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). -- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). -- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). -- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). -- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). -- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). -- elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). -- elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). -- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). -- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). -- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). -- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). -- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). -- sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). -- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) -- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - -Breaking Changes / Porting Guide --------------------------------- - -- ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. -- ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. -- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint``. -- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. -- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw``. -- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. -- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. -- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. -- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. -- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. -- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - -Deprecated Features -------------------- - -- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. -- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). -- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). -- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. - -Bugfixes --------- - -- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). -- aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries -- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). -- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). -- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). -- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). -- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). -- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). -- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). -- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). -- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). - -New Modules ------------ - -- aws_msk_cluster - Manage Amazon MSK clusters. -- aws_msk_config - Manage Amazon MSK cluster configurations. -- efs_tag - create and remove tags on Amazon EFS resources - v1.5.0 ====== diff --git a/README.md b/README.md index a04e88b9e9d..6c2e3fafdc9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ As the AWS SDK for Python (Boto3 and Botocore) has [ceased supporting Python 2.7 Starting with the 2.0.0 releases of amazon.aws and community.aws, it is generally the collection's policy to support the versions of `botocore` and `boto3` that were released 12 months prior to the most recent major collection release, following semantic versioning (for example, 2.0.0, 3.0.0). -Version 2.0.0 of this collection supports `boto3 >= 1.15.0` and `botocore >= 1.18.0` +Version 2.0.0 of this collection supports `boto3 >= 1.13.0` and `botocore >= 1.16.0` ## Included content @@ -59,8 +59,6 @@ Name | Description [community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets [community.aws.aws_kms](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_module.rst)|Perform various KMS management tasks. [community.aws.aws_kms_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_info_module.rst)|Gather information about AWS KMS keys -[community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters. -[community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations. [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions. [community.aws.aws_s3_bucket_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_bucket_info_module.rst)|lists S3 buckets in AWS [community.aws.aws_s3_cors](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_cors_module.rst)|Manage CORS for S3 buckets in AWS @@ -100,7 +98,10 @@ Name | Description [community.aws.ec2_customer_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_customer_gateway_info_module.rst)|Gather information about customer gateways in AWS [community.aws.ec2_eip](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_module.rst)|manages EC2 elastic IP (EIP) addresses. [community.aws.ec2_eip_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_info_module.rst)|List EC2 EIP details +[community.aws.ec2_elb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.ec2_elb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS +[community.aws.ec2_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_module.rst)|Create & manage EC2 instances +[community.aws.ec2_instance_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_info_module.rst)|Gather information about ec2 instances in AWS [community.aws.ec2_launch_template](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_launch_template_module.rst)|Manage EC2 launch templates [community.aws.ec2_lc](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_module.rst)|Create or delete AWS Autoscaling Launch Configurations [community.aws.ec2_lc_find](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_find_module.rst)|Find AWS Autoscaling Launch Configurations @@ -113,8 +114,15 @@ Name | Description [community.aws.ec2_transit_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_module.rst)|Create and delete AWS Transit Gateways [community.aws.ec2_transit_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_info_module.rst)|Gather information about ec2 transit gateways in AWS [community.aws.ec2_vpc_egress_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_egress_igw_module.rst)|Manage an AWS VPC Egress Only Internet gateway +[community.aws.ec2_vpc_endpoint](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_module.rst)|Create and delete AWS VPC Endpoints. +[community.aws.ec2_vpc_endpoint_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_info_module.rst)|Retrieves AWS VPC endpoints details using AWS methods. +[community.aws.ec2_vpc_endpoint_service_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_service_info_module.rst)|retrieves AWS VPC endpoint service details +[community.aws.ec2_vpc_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_module.rst)|Manage an AWS VPC Internet gateway +[community.aws.ec2_vpc_igw_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_info_module.rst)|Gather information about internet gateways in AWS [community.aws.ec2_vpc_nacl](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_module.rst)|create and delete Network ACLs. [community.aws.ec2_vpc_nacl_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_info_module.rst)|Gather information about Network ACLs in an AWS VPC +[community.aws.ec2_vpc_nat_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_module.rst)|Manage AWS VPC NAT Gateways. +[community.aws.ec2_vpc_nat_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst)|Retrieves AWS VPC Managed Nat Gateway details using AWS methods. [community.aws.ec2_vpc_peer](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peer_module.rst)|create, delete, accept, and reject VPC peering connections between two VPCs. [community.aws.ec2_vpc_peering_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peering_info_module.rst)|Retrieves AWS VPC Peering details using AWS methods. [community.aws.ec2_vpc_route_table](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_route_table_module.rst)|Manage route tables for AWS virtual private clouds @@ -135,7 +143,6 @@ Name | Description [community.aws.ecs_taskdefinition_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_taskdefinition_info_module.rst)|Describe a task definition in ECS [community.aws.efs](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_module.rst)|create and maintain EFS file systems [community.aws.efs_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_info_module.rst)|Get information about Amazon EFS file systems -[community.aws.efs_tag](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_tag_module.rst)|create and remove tags on Amazon EFS resources [community.aws.elasticache](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_module.rst)|Manage cache clusters in Amazon ElastiCache [community.aws.elasticache_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_info_module.rst)|Retrieve information for AWS ElastiCache clusters [community.aws.elasticache_parameter_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_parameter_group_module.rst)|Manage cache parameter groups in Amazon ElastiCache. @@ -143,6 +150,7 @@ Name | Description [community.aws.elasticache_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_subnet_group_module.rst)|manage ElastiCache subnet groups [community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application Load Balancer [community.aws.elb_application_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_info_module.rst)|Gather information about application ELBs in AWS +[community.aws.elb_classic_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_module.rst)|Creates or destroys Amazon ELB. [community.aws.elb_classic_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS [community.aws.elb_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_instance_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.elb_network_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_network_lb_module.rst)|Manage a Network Load Balancer diff --git a/bindep.txt b/bindep.txt deleted file mode 100644 index a336e642f5f..00000000000 --- a/bindep.txt +++ /dev/null @@ -1,4 +0,0 @@ -# Needed for generating EC2 format fingerprints -openssl [test platform:rpm] -gcc [test platform:rpm] -python3-devel [test platform:rpm] diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index ca10bd97e9e..1dfb7e79f32 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1125,222 +1125,3 @@ releases: name: wafv2_web_acl_info namespace: '' release_date: '2021-04-27' - 2.0.0: - changes: - breaking_changes: - - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_instance``. - - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_instance_info``. - - ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint``. - - ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. - - ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. - - ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. - - ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_vpc_igw``. - - ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_igw_info``. - - ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_igw_info``. - - ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. - - ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. - - ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. - - kms_info - key details are now returned in the ``kms_keys`` attribute rather - than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - bugfixes: - - aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). - - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict - with task retries - - ec2_vpc_peer - automatically retry when attempting to tag freshly created - peering connections (https://github.com/ansible-collections/community.aws/pull/614). - - ec2_vpc_route_table - automatically retry when attempting to modify freshly - created route tables (https://github.com/ansible-collections/community.aws/pull/616). - - ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). - - ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). - - ecs_taskdefinition - fix typo in ecs task defination for env file validations - (https://github.com/ansible-collections/community.aws/pull/600). - - iam_role - Modified iam_role internal code to replace update_role_description - with update_role (https://github.com/ansible-collections/community.aws/pull/697). - - route53 - fix typo in waiter configuration that prevented management of the - delays (https://github.com/ansible-collections/community.aws/pull/564). - - s3_sync - fix handling individual file path to upload a individual file to - s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). - - sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). - deprecated_features: - - ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` - module which functions identically. The original ``ec2_elb`` name is now deprecated - and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). - - ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated - in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` - module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). - - elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected - to the ``amazon.aws.ec2_elb_lb`` module which functions identically. - - iam - the boto based ``iam`` module has been deprecated in favour of the boto3 - based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module - will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). - - rds - the boto based ``rds`` module has been deprecated in favour of the boto3 - based ``rds_instance`` module. The ``rds`` module will be removed in release - 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). - - script_inventory_ec2 - The ec2.py inventory script is being moved to a new - repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py - and will be removed from this collection in the 3.0 release. We recommend - migrating from the script to the `amazon.aws.ec2` inventory plugin. - major_changes: - - community.aws collection - The community.aws collection has dropped support - for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). - Most modules will continue to work with older versions of the AWS SDK, however - compatability with older versions of the SDK is not guaranteed and will not - be tested. When using older versions of the SDK a warning will be emitted - by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). - minor_changes: - - aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch - bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) - - aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudformation_stack_set - Tests for compatability with older versions of - the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - dynamodb_table - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_asg - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - ec2_launch_template - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - ec2_transit_gateway - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_transit_gateway_info - Tests for compatability with older versions of - the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). - - ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). - - ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). - - ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). - - ecs_ecr - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_service - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_task - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). - - ecs_taskdefinition - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - efs - Tests for compatability with older versions of the AWS SDKs have been - removed (https://github.com/ansible-collections/community.aws/pull/675). - - efs_info - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). - - elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). - - elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). - - elb_application_lb - added ``ip_address_type`` parameter to support changing - application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). - - elb_application_lb_info - added ``ip_address_type`` in output when gathering - application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). - - elb_instance - make elb_instance idempotent when deregistering instances. Merged - from ec2_elb U(https://github.com/ansible/ansible/pull/31660). - - elb_network_lb - added ``ip_address_type`` parameter to support changing network - load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). - - elb_target_group - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - iam_role - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - kms_info - added a new ``keys_attr`` parameter to continue returning the key - details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - - lambda - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - rds_instance - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - rds_instance - convert ``preferred_maintenance_window`` days into lowercase - so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). - - rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - route53 - add rate-limiting retries while waiting for changes to propagate - (https://github.com/ansible-collections/community.aws/pull/564). - - route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). - - route53 - update retry ``max_delay`` setting so that it can be set above 60 - seconds (https://github.com/ansible-collections/community.aws/pull/564). - - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either - FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). - - sqs_queue - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) - - wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - fragments: - - 499-elb-module-add-ip_address_type_option.yml - - 516-rds_instance-preferred_maintenance_window.yml - - 564-route53-retries.yml - - 574-ecs_taskdefinition-improvement.yml - - 586-elb-renames.yml - - 592-sqs_queue-idempotent.yml - - 600-ecs-task-defination-env-file-validations.yml - - 614-ec2_vpc_peer-tagging.yml - - 616-ec2_vpc_route_table-tagging.yml - - 629-imports-cleanup.yml - - 648-kms_info.yml - - 659-checkmode.yml - - 663-deprecate-rds.yml - - 664-deprecate-iam.yml - - 675-boto3-minimums.yml - - 675-boto3-minimums.yml - - 681-aws_secret-deletion-idempotency.yml - - 682-aws_s3_bucket_info-botocore.yml - - 686-pylint.yml - - 688-pylint.yml - - 692-s3_sync-individual-file-path.yml - - 697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml - - 723-elasticache_subnet_group-boto3.yml - - deprecate_ec2_inv_script.yml - - migrate_ec2_instance.yml - - migrate_ec2_vpc_endpoint.yml - - migrate_ec2_vpc_igw.yml - - migrate_ec2_vpc_nat_gateway.yml - - rename-connection-retries.yml - - sns_topic_type.yml - modules: - - description: Manage Amazon MSK clusters. - name: aws_msk_cluster - namespace: '' - - description: Manage Amazon MSK cluster configurations. - name: aws_msk_config - namespace: '' - - description: create and remove tags on Amazon EFS resources - name: efs_tag - namespace: '' - release_date: '2021-09-14' diff --git a/changelogs/fragments/0-copy_ignore_txt.yml b/changelogs/fragments/0-copy_ignore_txt.yml deleted file mode 100644 index ec804d278dd..00000000000 --- a/changelogs/fragments/0-copy_ignore_txt.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Copy ignore.txt. diff --git a/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml b/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml new file mode 100644 index 00000000000..afc1f939be0 --- /dev/null +++ b/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml @@ -0,0 +1,4 @@ +minor_changes: +- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). diff --git a/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml b/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml new file mode 100644 index 00000000000..c986d684cbc --- /dev/null +++ b/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml @@ -0,0 +1,2 @@ +minor_changes: +- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). diff --git a/changelogs/fragments/564-route53-retries.yml b/changelogs/fragments/564-route53-retries.yml new file mode 100644 index 00000000000..46a99b56be2 --- /dev/null +++ b/changelogs/fragments/564-route53-retries.yml @@ -0,0 +1,6 @@ +bugfixes: +- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). +minor_changes: +- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). diff --git a/changelogs/fragments/574-ecs_taskdefinition-improvement.yml b/changelogs/fragments/574-ecs_taskdefinition-improvement.yml new file mode 100644 index 00000000000..c8667401464 --- /dev/null +++ b/changelogs/fragments/574-ecs_taskdefinition-improvement.yml @@ -0,0 +1,3 @@ +bugfixes: +- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). +- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). diff --git a/changelogs/fragments/586-elb-renames.yml b/changelogs/fragments/586-elb-renames.yml new file mode 100644 index 00000000000..0b799f0c0f6 --- /dev/null +++ b/changelogs/fragments/586-elb-renames.yml @@ -0,0 +1,8 @@ +minor_changes: +- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). +deprecated_features: +- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. + The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. + The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. diff --git a/changelogs/fragments/592-sqs_queue-idempotent.yml b/changelogs/fragments/592-sqs_queue-idempotent.yml new file mode 100644 index 00000000000..94bd5ef2388 --- /dev/null +++ b/changelogs/fragments/592-sqs_queue-idempotent.yml @@ -0,0 +1,2 @@ +bugfixes: +- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). diff --git a/changelogs/fragments/595-fix-route53-identifer.yaml b/changelogs/fragments/595-fix-route53-identifer.yaml deleted file mode 100644 index 11901c1655b..00000000000 --- a/changelogs/fragments/595-fix-route53-identifer.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). diff --git a/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml b/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml new file mode 100644 index 00000000000..e9186e00354 --- /dev/null +++ b/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml @@ -0,0 +1,2 @@ +bugfixes: +- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). diff --git a/changelogs/fragments/614-ec2_vpc_peer-tagging.yml b/changelogs/fragments/614-ec2_vpc_peer-tagging.yml new file mode 100644 index 00000000000..1e76f6b86ab --- /dev/null +++ b/changelogs/fragments/614-ec2_vpc_peer-tagging.yml @@ -0,0 +1,4 @@ +bugfixes: +- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). +minor_changes: +- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). diff --git a/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml b/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml new file mode 100644 index 00000000000..44ff49b8b38 --- /dev/null +++ b/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml @@ -0,0 +1,4 @@ +bugfixes: +- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). +minor_changes: +- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). diff --git a/changelogs/fragments/629-imports-cleanup.yml b/changelogs/fragments/629-imports-cleanup.yml new file mode 100644 index 00000000000..211aea45988 --- /dev/null +++ b/changelogs/fragments/629-imports-cleanup.yml @@ -0,0 +1,2 @@ +minor_changes: +- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) diff --git a/changelogs/fragments/648-kms_info.yml b/changelogs/fragments/648-kms_info.yml new file mode 100644 index 00000000000..8589c07cf4c --- /dev/null +++ b/changelogs/fragments/648-kms_info.yml @@ -0,0 +1,4 @@ +minor_changes: +- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). +breaking_changes: +- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). diff --git a/changelogs/fragments/659-checkmode.yml b/changelogs/fragments/659-checkmode.yml new file mode 100644 index 00000000000..dc9c541bb21 --- /dev/null +++ b/changelogs/fragments/659-checkmode.yml @@ -0,0 +1,10 @@ +minor_changes: +- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). diff --git a/changelogs/fragments/663-deprecate-rds.yml b/changelogs/fragments/663-deprecate-rds.yml new file mode 100644 index 00000000000..787a090903d --- /dev/null +++ b/changelogs/fragments/663-deprecate-rds.yml @@ -0,0 +1,3 @@ +deprecated_features: +- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. + The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). diff --git a/changelogs/fragments/664-deprecate-iam.yml b/changelogs/fragments/664-deprecate-iam.yml new file mode 100644 index 00000000000..b3dcc3665c2 --- /dev/null +++ b/changelogs/fragments/664-deprecate-iam.yml @@ -0,0 +1,3 @@ +deprecated_features: +- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. + The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). diff --git a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml b/changelogs/fragments/670-elb_target_group-new_attriibutes.yml deleted file mode 100644 index bff32308d56..00000000000 --- a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). - - elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). \ No newline at end of file diff --git a/changelogs/fragments/675-boto3-minimums.yml b/changelogs/fragments/675-boto3-minimums.yml new file mode 100644 index 00000000000..359636714d4 --- /dev/null +++ b/changelogs/fragments/675-boto3-minimums.yml @@ -0,0 +1,26 @@ +major_changes: +- community.aws collection - The community.aws collection has dropped support for ``botocore<1.16.0`` and ``boto3<1.13.0`` (https://github.com/ansible-collections/community.aws/pull/675). + Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. + When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). +minor_changes: +- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). diff --git a/changelogs/fragments/681-aws_secret-deletion-idempotency.yml b/changelogs/fragments/681-aws_secret-deletion-idempotency.yml new file mode 100644 index 00000000000..ac7910ef23b --- /dev/null +++ b/changelogs/fragments/681-aws_secret-deletion-idempotency.yml @@ -0,0 +1,2 @@ +bugfixes: +- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). diff --git a/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml b/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml new file mode 100644 index 00000000000..1577bd8d9a4 --- /dev/null +++ b/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml @@ -0,0 +1,2 @@ +minor_changes: +- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) diff --git a/changelogs/fragments/686-pylint.yml b/changelogs/fragments/686-pylint.yml new file mode 100644 index 00000000000..43b91aaef88 --- /dev/null +++ b/changelogs/fragments/686-pylint.yml @@ -0,0 +1,4 @@ +minor_changes: +- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). +- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). +- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). diff --git a/changelogs/fragments/688-pylint.yml b/changelogs/fragments/688-pylint.yml new file mode 100644 index 00000000000..6008db9cf0f --- /dev/null +++ b/changelogs/fragments/688-pylint.yml @@ -0,0 +1,10 @@ +minor_changes: +- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). diff --git a/changelogs/fragments/692-s3_sync-individual-file-path.yml b/changelogs/fragments/692-s3_sync-individual-file-path.yml new file mode 100644 index 00000000000..77b7ac80522 --- /dev/null +++ b/changelogs/fragments/692-s3_sync-individual-file-path.yml @@ -0,0 +1,2 @@ +bugfixes: +- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). diff --git a/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml b/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml new file mode 100644 index 00000000000..a31b43451d9 --- /dev/null +++ b/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml @@ -0,0 +1,2 @@ +bugfixes: +- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). diff --git a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml b/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml deleted file mode 100644 index 82f82192f72..00000000000 --- a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer connections (https://github.com/ansible-collections/community.aws/pull/707). diff --git a/changelogs/fragments/724-redshift_subnet_group-boto3.yml b/changelogs/fragments/724-redshift_subnet_group-boto3.yml deleted file mode 100644 index d760eb4c2b8..00000000000 --- a/changelogs/fragments/724-redshift_subnet_group-boto3.yml +++ /dev/null @@ -1,7 +0,0 @@ -minor_changes: -- redshift_subnet_group - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_description`` option has been renamed to ``description`` and is now optional. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` and is now only required when creating a new group. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). diff --git a/changelogs/fragments/728-iam_cert.yml b/changelogs/fragments/728-iam_cert.yml deleted file mode 100644 index 9fbb3d813cb..00000000000 --- a/changelogs/fragments/728-iam_cert.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_cert - the iam_cert module has been renamed to iam_server_certificate for consistency with the companion iam_server_certificate_info module. - The usage of the module has not changed. The iam_cert alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). diff --git a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml b/changelogs/fragments/731-ec2_eip-not_in_vpc.yml deleted file mode 100644 index 4020bffd273..00000000000 --- a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). diff --git a/changelogs/fragments/735-iam_server_certificate-file-names.yml b/changelogs/fragments/735-iam_server_certificate-file-names.yml deleted file mode 100644 index 58720919f7f..00000000000 --- a/changelogs/fragments/735-iam_server_certificate-file-names.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` and ``key`` parameters has been deprecated. - We recommend using a lookup plugin to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). diff --git a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml b/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml deleted file mode 100644 index 39f60733c2a..00000000000 --- a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). diff --git a/changelogs/fragments/deprecate_ec2_inv_script.yml b/changelogs/fragments/deprecate_ec2_inv_script.yml new file mode 100644 index 00000000000..b0cc461ee58 --- /dev/null +++ b/changelogs/fragments/deprecate_ec2_inv_script.yml @@ -0,0 +1,2 @@ +deprecated_features: +- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. diff --git a/changelogs/fragments/migrate_ec2_instance.yml b/changelogs/fragments/migrate_ec2_instance.yml new file mode 100644 index 00000000000..fb7c0fadfe7 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_instance.yml @@ -0,0 +1,3 @@ +breaking_changes: + - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. + - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_endpoint.yml b/changelogs/fragments/migrate_ec2_vpc_endpoint.yml new file mode 100644 index 00000000000..9b10b55a905 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_endpoint.yml @@ -0,0 +1,13 @@ +breaking_changes: +- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_endpoint``. +- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_igw.yml b/changelogs/fragments/migrate_ec2_vpc_igw.yml new file mode 100644 index 00000000000..6ab3da37409 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_igw.yml @@ -0,0 +1,10 @@ +breaking_changes: +- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw_info``. +- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw``. +- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml b/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml new file mode 100644 index 00000000000..678e30e87cd --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml @@ -0,0 +1,10 @@ +breaking_changes: +- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. +- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_nat_gateway``. +- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. diff --git a/changelogs/fragments/rename-connection-retries.yml b/changelogs/fragments/rename-connection-retries.yml new file mode 100644 index 00000000000..32cc97d3b9b --- /dev/null +++ b/changelogs/fragments/rename-connection-retries.yml @@ -0,0 +1,2 @@ +bugfixes: + - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries diff --git a/changelogs/fragments/sns_topic_type.yml b/changelogs/fragments/sns_topic_type.yml new file mode 100644 index 00000000000..3c57bb3be36 --- /dev/null +++ b/changelogs/fragments/sns_topic_type.yml @@ -0,0 +1,2 @@ +minor_changes: + - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.aws_acm_info_module.rst index c604a405734..45d16ff9e5e 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.aws_acm_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -178,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +194,7 @@ 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
@@ -227,7 +228,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -289,7 +290,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -301,9 +302,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_acm_module.rst b/docs/community.aws.aws_acm_module.rst index 57dbd56c4ba..29c2d490025 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.aws_acm_module.rst @@ -41,9 +41,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -285,6 +285,7 @@ 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
@@ -318,7 +319,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -360,7 +361,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -372,9 +373,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index 4f774d36cef..f1505078c9a 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -221,7 +221,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,6 +259,7 @@ 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
@@ -292,7 +293,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +450,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -463,9 +464,8 @@ Notes - A future version of this module will probably use tags or another ID so that an API can be created 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4606b53e9ae..8afeaa0e24a 100644 --- a/docs/community.aws.aws_application_scaling_policy_module.rst +++ b/docs/community.aws.aws_application_scaling_policy_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -244,6 +246,7 @@ 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
@@ -319,7 +322,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -517,7 +520,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -530,9 +533,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_compute_environment_module.rst b/docs/community.aws.aws_batch_compute_environment_module.rst index d8d542942be..01271a753d9 100644 --- a/docs/community.aws.aws_batch_compute_environment_module.rst +++ b/docs/community.aws.aws_batch_compute_environment_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -247,7 +247,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -343,6 +343,7 @@ 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
@@ -393,7 +394,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -517,7 +518,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -529,9 +530,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 93b37e4b1bc..4b821215793 100644 --- a/docs/community.aws.aws_batch_job_definition_module.rst +++ b/docs/community.aws.aws_batch_job_definition_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -413,6 +413,7 @@ 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
@@ -461,7 +462,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -598,7 +599,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -675,9 +676,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a385c7624a5..8fffc6d6d0d 100644 --- a/docs/community.aws.aws_batch_job_queue_module.rst +++ b/docs/community.aws.aws_batch_job_queue_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -194,7 +194,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -261,6 +261,7 @@ 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
@@ -294,7 +295,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +336,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -347,9 +348,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2d84d524e90..225a721095f 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -170,7 +171,7 @@ Parameters -
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.
+
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
@@ -189,7 +190,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -222,7 +223,7 @@ Parameters -
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.
+
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
@@ -324,7 +325,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -472,6 +473,7 @@ 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
@@ -505,7 +507,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -728,7 +730,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -756,9 +758,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9d30ec448f2..37f2d3bfe65 100644 --- a/docs/community.aws.aws_codecommit_module.rst +++ b/docs/community.aws.aws_codecommit_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +192,7 @@ 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
@@ -224,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -266,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -278,9 +280,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b6b2cd3c410..7dc4353b821 100644 --- a/docs/community.aws.aws_codepipeline_module.rst +++ b/docs/community.aws.aws_codepipeline_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -102,7 +103,7 @@ Parameters -
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.
+
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
@@ -121,7 +122,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -154,7 +155,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +224,7 @@ 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
@@ -272,7 +274,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -366,7 +368,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -394,9 +396,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2ce46985937..6fccefcc774 100644 --- a/docs/community.aws.aws_config_aggregation_authorization_module.rst +++ b/docs/community.aws.aws_config_aggregation_authorization_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -85,7 +86,7 @@ Parameters -
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.
+
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
@@ -104,7 +105,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -137,7 +138,7 @@ Parameters -
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.
+
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
@@ -174,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +191,7 @@ 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
@@ -223,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -264,7 +266,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -276,9 +278,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4dae621e755..174310c5eab 100644 --- a/docs/community.aws.aws_config_aggregator_module.rst +++ b/docs/community.aws.aws_config_aggregator_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -125,7 +126,7 @@ Parameters -
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.
+
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
@@ -144,7 +145,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -177,7 +178,7 @@ Parameters -
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.
+
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
@@ -214,7 +215,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -316,6 +317,7 @@ 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
@@ -349,7 +351,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -390,7 +392,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -402,9 +404,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e2940cf6c41..be94d2f101a 100644 --- a/docs/community.aws.aws_config_delivery_channel_module.rst +++ b/docs/community.aws.aws_config_delivery_channel_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -164,7 +165,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,6 +197,7 @@ 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
@@ -260,7 +262,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -316,7 +318,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -328,9 +330,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 439de0efbee..74132eb51ad 100644 --- a/docs/community.aws.aws_config_recorder_module.rst +++ b/docs/community.aws.aws_config_recorder_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -294,7 +296,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +337,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -347,9 +349,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 87e98cd929d..d33a4f33334 100644 --- a/docs/community.aws.aws_config_rule_module.rst +++ b/docs/community.aws.aws_config_rule_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -226,6 +227,7 @@ 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
@@ -339,7 +341,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +451,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +463,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 66a9fa6acb4..b105b278bbf 100644 --- a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +192,7 @@ 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
@@ -224,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +248,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cff65666871..10bf85bb695 100644 --- a/docs/community.aws.aws_direct_connect_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_connection_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +180,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -263,6 +264,7 @@ 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
@@ -296,7 +298,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -338,7 +340,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -350,9 +352,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d8bcfb3fbb4..6e4a37bd3ae 100644 --- a/docs/community.aws.aws_direct_connect_gateway_module.rst +++ b/docs/community.aws.aws_direct_connect_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -72,7 +72,7 @@ Parameters -
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.
+
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
@@ -91,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +124,7 @@ Parameters -
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.
+
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
@@ -177,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -208,6 +208,7 @@ 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
@@ -241,7 +242,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +284,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -326,9 +327,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 47a4b3f1a24..0aafe21240d 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 @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -301,6 +302,7 @@ 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
@@ -334,7 +336,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -376,7 +378,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -425,9 +427,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cac6b60f287..c959826cbce 100644 --- a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst +++ b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -98,7 +99,7 @@ Parameters -
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.
+
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
@@ -117,7 +118,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -150,7 +151,7 @@ Parameters -
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.
+
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
@@ -250,7 +251,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -298,6 +299,7 @@ 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
@@ -350,7 +352,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -392,7 +394,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -451,9 +453,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3bf9973bcdb..6a4e1be3b1c 100644 --- a/docs/community.aws.aws_eks_cluster_module.rst +++ b/docs/community.aws.aws_eks_cluster_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -238,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +297,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -357,9 +359,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3ad0c9fa24a..5ce6e64dd8d 100644 --- a/docs/community.aws.aws_elasticbeanstalk_app_module.rst +++ b/docs/community.aws.aws_elasticbeanstalk_app_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -69,7 +68,7 @@ Parameters -
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.
+
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
@@ -88,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +120,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +188,7 @@ 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
@@ -222,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +294,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 04afb555c95..2202ff9e781 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.aws_glue_connection_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -228,7 +228,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -276,6 +276,7 @@ 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
@@ -326,7 +327,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -384,7 +385,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -396,9 +397,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 00f0e68946c..ccbb2bd55f5 100644 --- a/docs/community.aws.aws_glue_job_module.rst +++ b/docs/community.aws.aws_glue_job_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -235,7 +235,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,6 +329,7 @@ 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
@@ -378,7 +379,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -435,7 +436,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -468,9 +469,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0a58c6f0f79..19d4cda8e15 100644 --- a/docs/community.aws.aws_inspector_target_module.rst +++ b/docs/community.aws.aws_inspector_target_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -264,7 +266,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -276,9 +278,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3753a1966d6..d13db70e882 100644 --- a/docs/community.aws.aws_kms_info_module.rst +++ b/docs/community.aws.aws_kms_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -161,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -199,28 +198,6 @@ Parameters

aliases: key_arn
- - -
- keys_attr - -
- boolean -
-
added in 2.0.0
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Whether to return the results in the keys attribute as well as the kms_keys attribute.
-
Returning the keys attribute conflicts with the builtin keys() method on dictionaries and as such has been deprecated.
-
After version 3.0.0 this parameter will do nothing, and after version 4.0.0 this parameter will be removed.
- -
@@ -252,6 +229,7 @@ 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
@@ -285,7 +263,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -307,7 +285,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -319,9 +297,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -362,7 +339,7 @@ Common return values are documented `here
- kms_keys + keys
complex diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index d51bc1bb2d5..210d4fcdee7 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -69,7 +68,7 @@ Parameters -
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.
+
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
@@ -88,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +120,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -482,6 +481,7 @@ 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
@@ -553,7 +553,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -609,7 +609,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -621,9 +621,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_msk_cluster_module.rst b/docs/community.aws.aws_msk_cluster_module.rst deleted file mode 100644 index b585d1861dc..00000000000 --- a/docs/community.aws.aws_msk_cluster_module.rst +++ /dev/null @@ -1,1031 +0,0 @@ -.. _community.aws.aws_msk_cluster_module: - - -***************************** -community.aws.aws_msk_cluster -***************************** - -**Manage Amazon MSK clusters.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- dictionary -
- 		- -
Includes all client authentication related information.
-
Effective only for new cluster and can not be updated.
-
-
- sasl_scram - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
SASL/SCRAM authentication is enabled or not.
-
-
- tls_ca_arn - -
- list - / elements=string -
- 		- -
List of ACM Certificate Authority ARNs.
-
-
- aws_access_key - -
- string -
- 		- -
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_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
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
-
-
- configuration_arn - -
- string -
- 		- -
ARN of the configuration to use.
-
This parameter is required when state=present.
-
-
- configuration_revision - -
- integer -
- 		- -
The revision of the configuration to use.
-
This parameter is required when state=present.
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- ebs_volume_size - -
- integer -
- 		- Default:
100
- 		-
The size in GiB of the EBS volume for the data drive on each broker node.
-
-
- ec2_url - -
- string -
- 		- -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- encryption - -
- dictionary -
- 		- -
Includes all encryption-related information.
-
Effective only for new cluster and can not be updated.
-
-
- in_transit - -
- dictionary -
- 		- -
The details for encryption in transit.
-
-
- client_broker - -
- string -
- 		-
    Choices: -
  • TLS ←
    • -
  • TLS_PLAINTEXT
    • -
  • PLAINTEXT
    • -
- 		-
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only.
-
-
- in_cluster - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
-
-
- kms_key_id - -
- string -
- 		- Default:
null
- 		-
The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
-
-
- enhanced_monitoring - -
- string -
- 		-
    Choices: -
  • DEFAULT ←
    • -
  • PER_BROKER
    • -
  • PER_TOPIC_PER_BROKER
    • -
  • PER_TOPIC_PER_PARTITION
    • -
- 		-
Specifies the level of monitoring for the MSK cluster.
-
-
- instance_type - -
- string -
- 		-
    Choices: -
  • kafka.t3.small ←
    • -
  • kafka.m5.large
    • -
  • kafka.m5.xlarge
    • -
  • kafka.m5.2xlarge
    • -
  • kafka.m5.4xlarge
    • -
- 		-
The type of Amazon EC2 instances to use for Kafka brokers.
-
Update operation requires botocore version >= 1.19.58.
-
-
- logging - -
- dictionary -
- 		- -
Logging configuration.
-
-
- cloudwatch - -
- dictionary -
- 		- -
Details of the CloudWatch Logs destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
-
-
- log_group - -
- string -
- 		- -
The CloudWatch log group that is the destination for broker logs.
-
-
- firehose - -
- dictionary -
- 		- -
Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
-
-
- delivery_stream - -
- string -
- 		- -
The Kinesis Data Firehose delivery stream that is the destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.
-
-
- s3 - -
- dictionary -
- 		- -
Details of the Amazon S3 destination for broker logs.
-
-
- bucket - -
- string -
- 		- -
The name of the S3 bucket that is the destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get sent to the specified Amazon S3 destination.
-
-
- prefix - -
- string -
- 		- -
The S3 prefix that is the destination for broker logs.
-
-
- name - -
- string - / required -
- 		- -
The name of the cluster.
-
-
- nodes - -
- integer -
- 		- Default:
3
- 		-
The number of broker nodes in the cluster. Should be greater or equal to two.
-
-
- open_monitoring - -
- dictionary -
- 		- -
The settings for open monitoring.
-
-
- jmx_exporter - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Indicates whether you want to enable or disable the JMX Exporter.
-
-
- node_exporter - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Indicates whether you want to enable or disable the Node Exporter.
-
-
- profile - -
- string -
- 		- -
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
-
-
- purge_tags - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Remove tags not listed in tags when tags is specified.
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- security_groups - -
- list - / elements=string -
- 		- -
The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
-
-
- security_token - -
- 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
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Create (present) or delete (absent) cluster.
-
-
- subnets - -
- list - / elements=string -
- 		- -
The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.
-
Client subnets can't be in Availability Zone us-east-1e.
-
This parameter is required when state=present.
-
-
- tags - -
- dictionary -
- 		- -
Tag dictionary to apply to the cluster.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
-
- version - -
- string -
- 		- -
The version of Apache Kafka.
-
This version should exist in given configuration.
-
This parameter is required when state=present.
-
Update operation requires botocore version >= 1.16.19.
-
-
- wait - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether to wait for the cluster to be available or deleted.
-
-
- wait_timeout - -
- integer -
- 		- Default:
3600
- 		-
How many seconds to wait. Cluster creation can take up to 20-30 minutes.
-
-
- - -Notes ------ - -.. note:: - - All operations are time consuming, for example create takes 20-30 minutes, update kafka version -- more than one hour, update configuration -- 10-15 minutes; - - Cluster's brokers get evenly distributed over a number of availability zones that's equal to the number of subnets. - - If parameters 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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. - - - -Examples --------- - -.. code-block:: yaml - - # Note: These examples do not set authentication details, see the AWS Guide for details. - - - aws_msk_cluster: - name: kafka-cluster - state: present - version: 2.6.1 - nodes: 6 - ebs_volume_size: "{{ aws_msk_options.ebs_volume_size }}" - subnets: - - subnet-e3b48ce7c25861eeb - - subnet-2990c8b25b07ddd43 - - subnet-d9fbeaf46c54bfab6 - wait: true - wait_timeout: 1800 - configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1 - configuration_revision: 1 - - - aws_msk_cluster: - name: kafka-cluster - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- bootstrap_broker_string - -
- complex -
- 		state=present and cluster state is ACTIVE -
A list of brokers that a client application can use to bootstrap.
-
-
  -
- plain - -
- string -
- 		-
A string containing one or more hostname:port pairs.
-
-
  -
- tls - -
- string -
- 		-
A string containing one or more DNS names (or IP) and TLS port pairs.
-
-
-
- cluster_info - -
- dictionary -
- 		state=present -
Description of the MSK cluster.
-
-
-
- response - -
- dictionary -
- 		always -
The response from actual API call.
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_msk_config_module.rst b/docs/community.aws.aws_msk_config_module.rst deleted file mode 100644 index 37fc97d7ac0..00000000000 --- a/docs/community.aws.aws_msk_config_module.rst +++ /dev/null @@ -1,435 +0,0 @@ -.. _community.aws.aws_msk_config_module: - - -**************************** -community.aws.aws_msk_config -**************************** - -**Manage Amazon MSK cluster configurations.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) cluster configurations. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- boto3 -- boto3 >= 1.15.0 -- botocore >= 1.17.48 -- botocore >= 1.18.0 -- python >= 3.6 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aws_access_key - -
- string -
- 		- -
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_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
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
-
-
- config - -
- dictionary -
- 		- -
Contents of the server.properties file.
-

aliases: configuration
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- description - -
- string -
- 		- -
The description of the configuration.
-
-
- ec2_url - -
- string -
- 		- -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- kafka_versions - -
- list - / elements=string -
- 		- -
The versions of Apache Kafka with which you can use this MSK configuration.
-
Required when state=present.
-
-
- name - -
- string - / required -
- 		- -
The name of the configuration.
-
-
- profile - -
- string -
- 		- -
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
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- security_token - -
- 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
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Create (present) or delete (absent) cluster configuration.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
-
- - -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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. - - - -Examples --------- - -.. code-block:: yaml - - # Note: These examples do not set authentication details, see the AWS Guide for details. - - - aws_msk_config: - name: kafka-cluster-configuration - state: present - kafka_versions: - - 2.6.0 - - 2.6.1 - config: - auto.create.topics.enable: false - num.partitions: 1 - default.replication.factor: 3 - zookeeper.session.timeout.ms: 18000 - - - aws_msk_config: - name: kafka-cluster-configuration - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- arn - -
- string -
- 		state=present -
The Amazon Resource Name (ARN) of the configuration.
-
-
Sample:
-
arn:aws:kafka:<region>:<account>:configuration/<name>/<resource-id>
-
-
- response - -
- dictionary -
- 		always -
The response from actual API call.
-
-
-
- revision - -
- integer -
- 		state=present -
The revision number.
-
-
Sample:
-
1
-
-
- server_properties - -
- string -
- 		state=present -
Contents of the server.properties file.
-
-
Sample:
-
default.replication.factor=3 - num.io.threads=8 - zookeeper.session.timeout.ms=18000
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_region_info_module.rst b/docs/community.aws.aws_region_info_module.rst index 39b2d55c302..dce1b7e7fe0 100644 --- a/docs/community.aws.aws_region_info_module.rst +++ b/docs/community.aws.aws_region_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -180,6 +181,7 @@ 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
@@ -213,7 +215,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -235,7 +237,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -247,9 +249,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f004a4c533f..4e8862e3d8c 100644 --- a/docs/community.aws.aws_s3_bucket_info_module.rst +++ b/docs/community.aws.aws_s3_bucket_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -308,7 +308,6 @@ Parameters
Retrive S3 ownership controls.
-
Access to bucket ownership controls requires botocore>=1.18.11.
@@ -483,7 +482,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -533,6 +532,7 @@ 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
@@ -566,7 +566,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -610,7 +610,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -622,9 +622,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 03af570f9f7..d0ca89d016d 100644 --- a/docs/community.aws.aws_s3_cors_module.rst +++ b/docs/community.aws.aws_s3_cors_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +277,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c350a06e078..9b72a3f31a4 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.aws_secret_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore>=1.10.0 +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,6 +205,7 @@ 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
@@ -321,7 +323,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -377,7 +379,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -389,9 +391,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a439fa43a8a..9cc37367205 100644 --- a/docs/community.aws.aws_ses_identity_module.rst +++ b/docs/community.aws.aws_ses_identity_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -310,7 +311,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -363,6 +364,7 @@ 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
@@ -396,7 +398,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -437,7 +439,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -449,9 +451,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f97c858a62f..177b0f20617 100644 --- a/docs/community.aws.aws_ses_identity_policy_module.rst +++ b/docs/community.aws.aws_ses_identity_policy_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -207,6 +208,7 @@ 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
@@ -240,7 +242,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -293,9 +295,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cf4454134db..8734e4ccac3 100644 --- a/docs/community.aws.aws_ses_rule_set_module.rst +++ b/docs/community.aws.aws_ses_rule_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -75,7 +76,7 @@ Parameters -
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.
+
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
@@ -94,7 +95,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -127,7 +128,7 @@ Parameters -
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.
+
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
@@ -164,7 +165,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -215,6 +216,7 @@ 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
@@ -248,7 +250,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -289,7 +291,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -301,9 +303,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ee750483fe2..00f665a0dab 100644 --- a/docs/community.aws.aws_sgw_info_module.rst +++ b/docs/community.aws.aws_sgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -235,6 +235,7 @@ 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
@@ -268,7 +269,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -290,7 +291,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -302,9 +303,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d88a1b506f6..5982f438b7e 100644 --- a/docs/community.aws.aws_ssm_connection.rst +++ b/docs/community.aws.aws_ssm_connection.rst @@ -137,39 +137,39 @@ Parameters
- reconnection_retries + region
- integer + -
- Default:
3
+ Default:
"us-east-1"
-
var: ansible_aws_ssm_retries
+
var: ansible_aws_ssm_region
-
Number of attempts to connect.
+
The region the EC2 instance is located.
- region + retries
- - + integer
- Default:
"us-east-1"
+ Default:
3
-
var: ansible_aws_ssm_region
+
var: ansible_aws_ssm_retries
-
The region the EC2 instance is located.
+
Number of attempts to connect.
diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.aws_ssm_parameter_store_module.rst index 76b06dcbd77..5e8a325f7bf 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/docs/community.aws.aws_ssm_parameter_store_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -176,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -245,6 +246,7 @@ 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
@@ -278,7 +280,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -361,7 +363,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -388,9 +390,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 76bdb9dc4bb..0e9159f0aca 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 @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -177,7 +176,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -255,6 +254,7 @@ 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
@@ -288,7 +288,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -325,7 +325,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -337,9 +337,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0706e8c3829..7a863fdcba0 100644 --- a/docs/community.aws.aws_step_functions_state_machine_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -159,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +190,7 @@ 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
@@ -259,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -315,7 +315,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +327,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 008043e9466..a22b1d2989d 100644 --- a/docs/community.aws.aws_waf_condition_module.rst +++ b/docs/community.aws.aws_waf_condition_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -437,6 +436,7 @@ 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
@@ -489,7 +489,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -555,7 +555,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -586,9 +586,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 85e18d75544..afc3aba03f5 100644 --- a/docs/community.aws.aws_waf_info_module.rst +++ b/docs/community.aws.aws_waf_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -260,9 +261,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4a122fdc547..f0a3dee30c5 100644 --- a/docs/community.aws.aws_waf_rule_module.rst +++ b/docs/community.aws.aws_waf_rule_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -222,7 +221,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -272,6 +271,7 @@ 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
@@ -324,7 +324,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -396,9 +396,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 117059745dd..b6031af80c4 100644 --- a/docs/community.aws.aws_waf_web_acl_module.rst +++ b/docs/community.aws.aws_waf_web_acl_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -162,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +211,7 @@ 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
@@ -352,7 +352,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -393,7 +393,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -424,9 +424,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9bd43334bb1..8047723c9ed 100644 --- a/docs/community.aws.cloudformation_exports_info_module.rst +++ b/docs/community.aws.cloudformation_exports_info_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.11.15 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +158,7 @@ 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
@@ -191,7 +192,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -213,7 +214,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -225,9 +226,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1ad9dd1f311..268c58f6106 100644 --- a/docs/community.aws.cloudformation_stack_set_module.rst +++ b/docs/community.aws.cloudformation_stack_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3>=1.6 +- botocore>=1.10.26 +- python >= 2.6 Parameters @@ -87,7 +88,7 @@ Parameters -
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.
+
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
@@ -106,7 +107,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -139,7 +140,7 @@ Parameters -
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.
+
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
@@ -213,7 +214,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -367,6 +368,7 @@ 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
@@ -437,7 +439,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -547,7 +549,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -596,9 +598,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4274b12a5cc..7fe2ada6fa1 100644 --- a/docs/community.aws.cloudfront_distribution_module.rst +++ b/docs/community.aws.cloudfront_distribution_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -85,7 +85,7 @@ Parameters -
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.
+
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
@@ -104,7 +104,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -137,7 +137,7 @@ Parameters -
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.
+
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
@@ -1314,7 +1314,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1719,44 +1719,10 @@ Parameters
Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront.
-
Will automatically create an Identity for you if no s3_origin_config is specified.
+
Will automatically create an Identity for you.
- - - -
- s3_origin_config - -
- dictionary -
- - - - -
Specify origin access identity for S3 origins.
- - - - - - -
- origin_access_identity - -
- string -
- - - - -
Existing origin access identity in the format origin-access-identity/cloudfront/OID_ID.
- - - @@ -1790,6 +1756,7 @@ 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
@@ -1991,7 +1958,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -2050,7 +2017,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -2217,9 +2184,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -4478,44 +4444,6 @@ Common return values are documented `here - -   -   - -
- s3_origin_config - -
- dictionary -
- - when s3_origin_access_identity_enabled is true - -
Origin access identity configuration for S3 Origin.
-
- - - -   -   -   - -
- origin_access_identity - -
- string -
- - - -
The origin access id as a path.
-
-
Sample:
-
origin-access-identity/cloudfront/EXAMPLEID
- - -   diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 9766f960ce7..3bc0915dd8d 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -73,7 +73,7 @@ Parameters -
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.
+
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
@@ -92,7 +92,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +125,7 @@ Parameters -
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.
+
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
@@ -232,7 +232,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -437,6 +437,7 @@ 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
@@ -470,7 +471,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -552,7 +553,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -564,9 +565,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1b64c27ef53..eef95720fe4 100644 --- a/docs/community.aws.cloudfront_invalidation_module.rst +++ b/docs/community.aws.cloudfront_invalidation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -189,7 +189,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +205,7 @@ 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
@@ -238,7 +239,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -290,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 45ffd8bb0c8..69a2da9de57 100644 --- a/docs/community.aws.cloudfront_origin_access_identity_module.rst +++ b/docs/community.aws.cloudfront_origin_access_identity_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -203,6 +203,7 @@ 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
@@ -236,7 +237,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -290,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3f3baa82c07..b124fa5915e 100644 --- a/docs/community.aws.cloudtrail_module.rst +++ b/docs/community.aws.cloudtrail_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -176,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -305,6 +306,7 @@ 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
@@ -371,7 +373,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +451,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +463,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 441d276d550..ec1834b10d7 100644 --- a/docs/community.aws.cloudwatchevent_rule_module.rst +++ b/docs/community.aws.cloudwatchevent_rule_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,6 +204,7 @@ 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
@@ -267,7 +268,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -461,7 +462,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -475,9 +476,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6206c9deba1..3635b8f5839 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 350ac92429c..c0e448046ba 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -286,6 +287,7 @@ 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
@@ -319,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -361,7 +363,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -373,9 +375,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 17ceecb94bc..2dbc487ef7c 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,6 +211,7 @@ 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
@@ -279,7 +282,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +338,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -348,9 +351,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 08740070baa..167cf82e78a 100644 --- a/docs/community.aws.data_pipeline_module.rst +++ b/docs/community.aws.data_pipeline_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -398,6 +398,7 @@ 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
@@ -431,7 +432,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -505,7 +506,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -581,9 +582,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 38fe9ee552f..6c1730d99e4 100644 --- a/docs/community.aws.dms_endpoint_module.rst +++ b/docs/community.aws.dms_endpoint_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -202,7 +201,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -405,6 +404,7 @@ 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
@@ -469,7 +469,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -607,7 +607,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -638,9 +638,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f6b208ddff4..25e0fa5b98d 100644 --- a/docs/community.aws.dms_replication_subnet_group_module.rst +++ b/docs/community.aws.dms_replication_subnet_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +189,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -293,9 +293,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a4c0979d3b6..8de198abe68 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -27,10 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- boto >= 2.37.0 +- boto3 >= 1.4.4 (for tagging) +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -381,6 +381,7 @@ 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
@@ -465,7 +466,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -522,7 +523,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -566,9 +567,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 50ed4076859..99a2502b13c 100644 --- a/docs/community.aws.dynamodb_ttl_module.rst +++ b/docs/community.aws.dynamodb_ttl_module.rst @@ -17,7 +17,8 @@ Version added: 1.0.0 Synopsis -------- -- Sets the TTL for a given DynamoDB table. +- Uses boto3 to set TTL. +- Requires botocore version 1.5.24 or higher. @@ -25,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore>=1.5.24 +- python >= 2.6 Parameters @@ -70,7 +72,7 @@ Parameters -
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.
+
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
@@ -89,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +124,7 @@ Parameters -
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.
+
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
@@ -159,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +177,7 @@ 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
@@ -208,7 +211,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +280,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 bb3feebab07..42c5f779dff 100644 --- a/docs/community.aws.ec2_ami_copy_module.rst +++ b/docs/community.aws.ec2_ami_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -344,7 +345,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -394,9 +395,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 64df8d3cf18..5f7e4ae800f 100644 --- a/docs/community.aws.ec2_asg_info_module.rst +++ b/docs/community.aws.ec2_asg_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +175,7 @@ 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
@@ -208,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c093c9d89a6..e950d3b0b3e 100644 --- a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst +++ b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3>=1.4.4 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,6 +259,7 @@ 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
@@ -307,7 +308,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -369,7 +370,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -381,9 +382,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4422e8af239..ca3cdbf4ee0 100644 --- a/docs/community.aws.ec2_asg_module.rst +++ b/docs/community.aws.ec2_asg_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -708,6 +709,7 @@ 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
@@ -792,7 +794,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -909,7 +911,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -972,9 +974,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 8034b96949c..3d08a50f855 100644 --- a/docs/community.aws.ec2_customer_gateway_info_module.rst +++ b/docs/community.aws.ec2_customer_gateway_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a38ee5dfe0c..9d81a8bcb54 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -257,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -298,7 +300,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -312,9 +314,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2cfcd570736..d742f823cc0 100644 --- a/docs/community.aws.ec2_eip_info_module.rst +++ b/docs/community.aws.ec2_eip_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +174,7 @@ 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
@@ -208,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -242,9 +242,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 921e424b8ba..dd674bbb9d4 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -73,7 +72,7 @@ Parameters -
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.
+
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
@@ -92,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +124,7 @@ Parameters -
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.
+
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
@@ -179,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -230,6 +229,7 @@ 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
@@ -334,7 +334,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -406,7 +406,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -435,9 +435,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4ccc2a76a92..7689fb8882f 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -14,13 +14,6 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The ec2_elb_info is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`elb_classic_lb_info `. - - Synopsis -------- @@ -33,10 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -62,7 +53,7 @@ Parameters -
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.
+
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
@@ -81,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -114,7 +105,7 @@ Parameters -
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.
+
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
@@ -151,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -183,6 +174,7 @@ 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
@@ -216,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -238,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -250,9 +242,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -297,10 +288,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.efs_tag_module.rst b/docs/community.aws.ec2_elb_module.rst similarity index 72% rename from docs/community.aws.efs_tag_module.rst rename to docs/community.aws.ec2_elb_module.rst index 838b239d74f..39b33d7c74b 100644 --- a/docs/community.aws.efs_tag_module.rst +++ b/docs/community.aws.ec2_elb_module.rst @@ -1,14 +1,14 @@ -.. _community.aws.efs_tag_module: +.. _community.aws.ec2_elb_module: ********************* -community.aws.efs_tag +community.aws.ec2_elb ********************* -**create and remove tags on Amazon EFS resources** +**De-registers or registers instances from EC2 ELBs** -Version added: 2.0.0 +Version added: 1.0.0 .. contents:: :local: @@ -17,8 +17,9 @@ Version added: 2.0.0 Synopsis -------- -- Creates and removes tags for Amazon EFS resources. -- Resources are referenced by their ID (filesystem or filesystem access point). +- This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. +- Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. +- Will be marked changed when called only if there are ELBs found to operate on. @@ -26,9 +27,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -134,23 +134,24 @@ Parameters
- ec2_url + ec2_elbs
- string + list + / elements=string
-
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
+
List of ELB names, required for registration.
+
The ec2_elbs fact should be used if there was a previous de-register.
- profile + ec2_url
string @@ -159,15 +160,14 @@ Parameters -
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
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
- purge_tags + enable_availability_zone
boolean @@ -175,45 +175,62 @@ Parameters
    Choices: -
  • no ←
    • -
  • yes
    • +
  • no
    • +
  • yes ←
-
Whether unspecified tags should be removed from the resource.
-
Note that when combined with state=absent, specified tags with non-matching values are not purged.
+
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
- region + instance_id
string + / required
-
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
+
EC2 Instance ID
- resource + profile
string - / required
-
EFS Filesystem ID or EFS Filesystem Access Point ID.
+
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
+ + + + +
+ region + +
+ string +
+ + + + +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
@@ -228,7 +245,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -241,39 +258,42 @@ Parameters
string + / required
    Choices: -
  • present ←
    • +
  • present
  • absent
-
Whether the tags should be present or absent on the resource.
+
register or deregister the instance
- tags + validate_certs
- dictionary - / required + boolean
+
    Choices: +
  • no
    • +
  • yes ←
    • +
-
A dictionary of tags to add or remove from the resource.
-
If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- validate_certs + wait
boolean @@ -286,7 +306,23 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
Wait for instance registration or deregistration to complete successfully before returning.
+ + + + +
+ wait_timeout + +
+ integer +
+ + + Default:
0
+ + +
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
@@ -298,9 +334,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -309,97 +344,23 @@ Examples .. code-block:: yaml - - name: Ensure tags are present on a resource - community.aws.efs_tag: - resource: fs-123456ab - state: present - tags: - Name: MyEFS - Env: Production - - - name: Remove the Env tag if it's currently 'development' - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: - Env: development - - - name: Remove all tags except for Name - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: - Name: foo - purge_tags: true - - - name: Remove all tags - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: {} - purge_tags: true - - + # basic pre_task and post_task example + pre_tasks: + - name: Instance De-register + community.aws.ec2_elb: + instance_id: "{{ ansible_ec2_instance_id }}" + state: absent + roles: + - myrole + post_tasks: + - name: Instance Register + community.aws.ec2_elb: + instance_id: "{{ ansible_ec2_instance_id }}" + ec2_elbs: "{{ item }}" + state: present + loop: "{{ ec2_elbs }}" -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- added_tags - -
- dictionary -
- 		If tags were added -
A dict of tags that were added to the resource
-
-
-
- removed_tags - -
- dictionary -
- 		If tags were removed -
A dict of tags that were removed from the resource
-
-
-
- tags - -
- dictionary -
- 		always -
A dict containing the tags on the resource
-
-
-

Status @@ -409,4 +370,4 @@ Status Authors ~~~~~~~ -- Milan Zink (@zeten30) +- John Jarvis (@jarv) diff --git a/docs/community.aws.ec2_launch_template_module.rst b/docs/community.aws.ec2_launch_template_module.rst index 0df31038a64..3bec3a190f9 100644 --- a/docs/community.aws.ec2_launch_template_module.rst +++ b/docs/community.aws.ec2_launch_template_module.rst @@ -18,7 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups. -- The :ref:`amazon.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. +- The :ref:`community.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.6.0 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -489,7 +490,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1153,6 +1154,7 @@ 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
@@ -1233,7 +1235,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1339,7 +1341,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -1351,9 +1353,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b4ef0e22906..803e4898d12 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +194,7 @@ 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
@@ -227,7 +228,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +269,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -280,9 +281,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c69ad922727..e8b6bcecd0b 100644 --- a/docs/community.aws.ec2_lc_info_module.rst +++ b/docs/community.aws.ec2_lc_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +176,7 @@ 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
@@ -209,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -307,7 +308,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -319,9 +320,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2ce6e3fdd6f..af1f0bff3f3 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- python >= 2.6 Parameters @@ -92,7 +92,7 @@ Parameters -
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.
+
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
@@ -111,7 +111,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -144,7 +144,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -393,6 +393,7 @@ 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
@@ -457,7 +458,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -543,7 +544,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -753,9 +754,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d55e599ddc7..c15290999b5 100644 --- a/docs/community.aws.ec2_metric_alarm_module.rst +++ b/docs/community.aws.ec2_metric_alarm_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -70,7 +69,7 @@ Parameters -
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.
+
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
@@ -89,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +121,7 @@ Parameters -
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.
+
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
@@ -217,7 +216,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -342,6 +341,7 @@ 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
@@ -375,7 +375,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -519,7 +519,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -531,9 +531,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 afc05c66621..e231cde5eab 100644 --- a/docs/community.aws.ec2_placement_group_info_module.rst +++ b/docs/community.aws.ec2_placement_group_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +175,7 @@ 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
@@ -209,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -243,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 eda2dffdb8e..8c9186c2349 100644 --- a/docs/community.aws.ec2_placement_group_module.rst +++ b/docs/community.aws.ec2_placement_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -267,7 +267,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -279,9 +279,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a5a0ac17605..76dab5ffd11 100644 --- a/docs/community.aws.ec2_scaling_policy_module.rst +++ b/docs/community.aws.ec2_scaling_policy_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -91,7 +90,7 @@ Parameters -
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.
+
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
@@ -110,7 +109,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -143,7 +142,7 @@ Parameters -
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.
+
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
@@ -196,7 +195,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -299,6 +298,7 @@ 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
@@ -350,7 +350,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -461,7 +461,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -473,9 +473,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9f93e140860..f3f55ee91e5 100644 --- a/docs/community.aws.ec2_snapshot_copy_module.rst +++ b/docs/community.aws.ec2_snapshot_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -207,6 +207,7 @@ 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
@@ -240,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -309,7 +310,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -356,9 +357,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 27c90dc71ac..052da82c68b 100644 --- a/docs/community.aws.ec2_transit_gateway_info_module.rst +++ b/docs/community.aws.ec2_transit_gateway_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,6 +174,7 @@ 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
@@ -206,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 18f76c66a2d..669edfae9bb 100644 --- a/docs/community.aws.ec2_transit_gateway_module.rst +++ b/docs/community.aws.ec2_transit_gateway_module.rst @@ -27,9 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -128,7 +129,7 @@ Parameters -
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.
+
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
@@ -147,7 +148,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -180,7 +181,7 @@ Parameters -
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.
+
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
@@ -251,7 +252,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -267,6 +268,7 @@ 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
@@ -319,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -391,7 +393,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -457,9 +459,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4043cf775d6..6d309eab2b7 100644 --- a/docs/community.aws.ec2_vpc_egress_igw_module.rst +++ b/docs/community.aws.ec2_vpc_egress_igw_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +157,7 @@ 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
@@ -191,7 +191,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -232,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -260,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e690d470631..2a433f70523 100644 --- a/docs/community.aws.ec2_vpc_nacl_info_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,6 +193,7 @@ 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
@@ -226,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -248,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +262,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_module.rst b/docs/community.aws.ec2_vpc_nacl_module.rst index 329f218f0bc..d935d3377be 100644 --- a/docs/community.aws.ec2_vpc_nacl_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -224,6 +226,7 @@ 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
@@ -257,7 +260,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -332,7 +335,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -360,9 +363,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f6183111a62..c59ff562990 100644 --- a/docs/community.aws.ec2_vpc_peer_module.rst +++ b/docs/community.aws.ec2_vpc_peer_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -218,31 +220,12 @@ 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
- - -
- purge_tags - -
- boolean -
-
added in 2.0.0
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Remove tags not listed in tags.
- -
@@ -271,7 +254,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -329,7 +312,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -375,9 +358,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c23282c99b1..64d7086b0f2 100644 --- a/docs/community.aws.ec2_vpc_peering_info_module.rst +++ b/docs/community.aws.ec2_vpc_peering_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 59976e4a317..18265c7b2fe 100644 --- a/docs/community.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +241,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0468df68e68..b083c49731f 100644 --- a/docs/community.aws.ec2_vpc_route_table_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -177,6 +176,7 @@ 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
@@ -316,7 +316,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -389,7 +389,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -417,9 +417,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 307b0fa3046..a61eb76c01b 100644 --- a/docs/community.aws.ec2_vpc_vgw_info_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5da685210ba..b6654ad119f 100644 --- a/docs/community.aws.ec2_vpc_vgw_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -224,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -300,7 +301,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -358,9 +359,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 be6c5130e75..b182e0279ba 100644 --- a/docs/community.aws.ec2_vpc_vpn_info_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b6dd8e5e6cb..b6fca122c45 100644 --- a/docs/community.aws.ec2_vpc_vpn_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -190,7 +191,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -382,6 +383,7 @@ 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
@@ -469,7 +471,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -593,7 +595,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -651,9 +653,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ddba8b42e43..4e3aca0c7af 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -26,11 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto - cryptography -- python >= 3.6 +- python >= 2.6 Parameters @@ -56,7 +54,7 @@ Parameters -
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.
+
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
@@ -75,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +106,7 @@ Parameters -
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.
+
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
@@ -145,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -224,6 +222,7 @@ 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
@@ -257,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -279,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +326,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5948d4227bc..6c9dc4f6e64 100644 --- a/docs/community.aws.ecs_attribute_module.rst +++ b/docs/community.aws.ecs_attribute_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -123,7 +124,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -156,7 +157,7 @@ Parameters -
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.
+
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
@@ -225,7 +226,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -241,6 +242,7 @@ 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
@@ -274,7 +276,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -315,7 +317,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +329,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_cluster_module.rst b/docs/community.aws.ecs_cluster_module.rst index d7f56836de7..c198e3fcba4 100644 --- a/docs/community.aws.ecs_cluster_module.rst +++ b/docs/community.aws.ecs_cluster_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -239,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -296,9 +297,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 8227a7a7e0e..853e153ab9d 100644 --- a/docs/community.aws.ecs_ecr_module.rst +++ b/docs/community.aws.ecs_ecr_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -242,6 +242,7 @@ 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
@@ -339,6 +340,7 @@ Parameters
if true, images are scanned for known vulnerabilities after being pushed to the repository.
+
scan_on_push requires botocore >= 1.13.3
@@ -353,7 +355,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -394,7 +396,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -406,9 +408,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 39b3f073f96..4d60e6d3480 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -26,9 +26,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -54,7 +56,7 @@ Parameters -
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.
+
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
@@ -73,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +108,7 @@ Parameters -
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.
+
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
@@ -177,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +214,7 @@ 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
@@ -245,7 +248,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +286,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -295,9 +298,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_module.rst b/docs/community.aws.ecs_service_module.rst index dc0663aaa06..d510fe56790 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -253,7 +255,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -289,6 +291,7 @@ Parameters
Seconds to wait before health checking the freshly added/updated services.
+
This option requires botocore >= 1.8.20.
@@ -355,6 +358,7 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+
assign_public_ip requires botocore >= 1.8.4
@@ -375,6 +379,7 @@ Parameters
Whether the task's elastic network interface receives a public IP address.
+
This option requires botocore >= 1.8.4.
@@ -540,6 +545,7 @@ 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
@@ -625,7 +631,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -749,7 +755,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -764,9 +770,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index d3b69c383ea..bbd6c2f793f 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +176,7 @@ 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
@@ -266,7 +268,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -323,7 +325,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -336,9 +338,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5847ab1df45..128ef7f6971 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -189,7 +191,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -225,6 +227,7 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+
assign_public_ip requires botocore >= 1.8.4
@@ -334,6 +337,7 @@ 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
@@ -367,7 +371,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +453,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +465,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_info_module.rst b/docs/community.aws.ecs_taskdefinition_info_module.rst index efb12e4debf..01f268e4ac5 100644 --- a/docs/community.aws.ecs_taskdefinition_info_module.rst +++ b/docs/community.aws.ecs_taskdefinition_info_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +160,7 @@ 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
@@ -191,7 +194,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -243,9 +246,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9de5fcbc0e3..0132cbad123 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -25,12 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. +- boto - boto3 -- boto3 >= 1.15.0 - botocore -- botocore >= 1.18.0 - json -- python >= 3.6 +- python >= 2.6 Parameters @@ -71,7 +70,7 @@ Parameters -
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.
+
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
@@ -90,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +122,7 @@ Parameters -
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.
+
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
@@ -613,7 +612,7 @@ Parameters linuxParameters
- dictionary + list
@@ -1585,23 +1584,6 @@ Parameters
-
    Choices: -
  • core
    • -
  • cpu
    • -
  • data
    • -
  • fsize
    • -
  • locks
    • -
  • memlock
    • -
  • msgqueue
    • -
  • nice
    • -
  • nofile
    • -
  • nproc
    • -
  • rss
    • -
  • rtprio
    • -
  • rttime
    • -
  • sigpending
    • -
  • stack
    • -
The type of the ulimit.
@@ -1763,7 +1745,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1888,6 +1870,7 @@ 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
@@ -1936,7 +1919,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1993,7 +1976,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -2039,9 +2022,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -2202,4 +2184,3 @@ Authors ~~~~~~~ - Mark Chance (@Java1Guy) -- Alina Buzachis (@alinabuzachis) diff --git a/docs/community.aws.efs_info_module.rst b/docs/community.aws.efs_info_module.rst index ebe311c9ec4..ab8ebd81da8 100644 --- a/docs/community.aws.efs_info_module.rst +++ b/docs/community.aws.efs_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -289,9 +290,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -531,7 +531,7 @@ Common return values are documented `here float
- when throughput_mode is set to "provisioned" + when botocore >= 1.10.57 and throughput_mode is set to "provisioned"
throughput provisioned in Mibps

@@ -582,7 +582,7 @@ Common return values are documented `here string
- always + when botocore >= 1.10.57
mode of throughput for the file system

diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 60d6071897c..06279ae5a2b 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -241,6 +241,7 @@ 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
@@ -259,6 +260,7 @@ Parameters
If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
+
Requires botocore >= 1.10.57
@@ -308,7 +310,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -432,6 +434,7 @@ Parameters
The throughput_mode for the file system to be created.
+
Requires botocore >= 1.10.57
@@ -450,7 +453,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -497,9 +500,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 775b3d36441..34254514c00 100644 --- a/docs/community.aws.elasticache_info_module.rst +++ b/docs/community.aws.elasticache_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +241,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 eb3c8e43697..0466cff2964 100644 --- a/docs/community.aws.elasticache_module.rst +++ b/docs/community.aws.elasticache_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -222,7 +222,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -324,6 +324,7 @@ 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
@@ -373,7 +374,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -417,7 +418,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -463,9 +464,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3f93a6865e5..d7554eb5d56 100644 --- a/docs/community.aws.elasticache_parameter_group_module.rst +++ b/docs/community.aws.elasticache_parameter_group_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -158,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -214,6 +215,7 @@ 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
@@ -247,7 +249,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -290,7 +292,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -317,9 +319,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 28218326b5e..73ccdec22d3 100644 --- a/docs/community.aws.elasticache_snapshot_module.rst +++ b/docs/community.aws.elasticache_snapshot_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -173,7 +174,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -253,7 +255,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -311,7 +313,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -323,9 +325,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 260f6a84026..cedd9859da5 100644 --- a/docs/community.aws.elasticache_subnet_group_module.rst +++ b/docs/community.aws.elasticache_subnet_group_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates, modifies, and deletes ElastiCache subnet groups. +- Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,8 +141,7 @@ Parameters -
ElastiCache subnet group description.
-
When not provided defaults to name on subnet group creation.
+
ElastiCache subnet group description. Only set when a new group is added.
@@ -158,7 +156,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +174,6 @@ Parameters
Database subnet group identifier.
-
This value is automatically converted to lowercase.
@@ -191,6 +188,7 @@ 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
@@ -224,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -237,11 +235,12 @@ Parameters
string + / required
    Choices: -
  • present ←
    • +
  • present
  • absent
@@ -263,7 +262,6 @@ Parameters
List of subnet IDs that make up the ElastiCache subnet group.
-
At least one subnet must be provided when creating an ElastiCache subnet group.
@@ -282,7 +280,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +292,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -321,128 +318,6 @@ Examples -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cache_subnet_group - -
- dictionary -
- 		always -
Description of the Elasticache Subnet Group.
-
-
  -
- arn - -
- string -
- 		when the subnet group exists -
The Amazon Resource Name (ARN) of the cache subnet group.
-
-
Sample:
-
arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue
-
  -
- description - -
- string -
- 		when the cache subnet group exists -
The description of the cache subnet group.
-
-
Sample:
-
My Fancy Ex Parrot Subnet Group
-
  -
- name - -
- string -
- 		when the cache subnet group exists -
The name of the cache subnet group.
-
-
Sample:
-
norwegian-blue
-
  -
- subnet_ids - -
- list - / elements=string -
- 		when the cache subnet group exists -
The IDs of the subnets beloging to the cache subnet group.
-
-
Sample:
-
['subnet-aaaaaaaa', 'subnet-bbbbbbbb']
-
  -
- vpc_id - -
- string -
- 		when the cache subnet group exists -
The VPC ID of the cache subnet group.
-
-
Sample:
-
norwegian-blue
-
-

- Status ------ diff --git a/docs/community.aws.elb_application_lb_info_module.rst b/docs/community.aws.elb_application_lb_info_module.rst index d511a3ddc24..ef71064e90b 100644 --- a/docs/community.aws.elb_application_lb_info_module.rst +++ b/docs/community.aws.elb_application_lb_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -224,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -332,7 +332,7 @@ Common return values are documented `here string
- + when status is present
The name of the S3 bucket for the access logs.

@@ -350,7 +350,7 @@ Common return values are documented `here string - + when status is present
Indicates whether access logs stored in Amazon S3 are enabled.

@@ -368,7 +368,7 @@ Common return values are documented `here string - + when status is present
The prefix for the location in the S3 bucket.

@@ -386,7 +386,7 @@ Common return values are documented `here list - + when status is present
The Availability Zones for the load balancer.

@@ -404,7 +404,7 @@ Common return values are documented `here string - + when status is present
The ID of the Amazon Route 53 hosted zone associated with the load balancer.

@@ -422,7 +422,7 @@ Common return values are documented `here string - + when status is present
The date and time the load balancer was created.

@@ -440,7 +440,7 @@ Common return values are documented `here string - + when status is present
Indicates whether deletion protection is enabled.

@@ -458,7 +458,7 @@ Common return values are documented `here string - + when status is present
The public DNS name of the load balancer.

@@ -476,7 +476,7 @@ Common return values are documented `here string - + when status is present
The idle timeout value, in seconds.

@@ -494,7 +494,7 @@ Common return values are documented `here string - + when status is present
The type of IP addresses used by the subnets for the load balancer.

@@ -512,7 +512,7 @@ Common return values are documented `here string - + when status is present
The Amazon Resource Name (ARN) of the load balancer.

@@ -530,7 +530,7 @@ Common return values are documented `here string - + when status is present
The name of the load balancer.

@@ -548,7 +548,7 @@ Common return values are documented `here string - + when status is present
Internet-facing or internal load balancer.

@@ -566,7 +566,7 @@ Common return values are documented `here list - + when status is present
The IDs of the security groups for the load balancer.

@@ -584,7 +584,7 @@ Common return values are documented `here dictionary - + when status is present
The state of the load balancer.

@@ -602,7 +602,7 @@ Common return values are documented `here dictionary - + when status is present
The tags attached to the load balancer.

@@ -620,7 +620,7 @@ Common return values are documented `here string - + when status is present
The type of load balancer.

@@ -638,7 +638,7 @@ Common return values are documented `here string - + when status is present
The ID of the VPC for the load balancer.

diff --git a/docs/community.aws.elb_application_lb_module.rst b/docs/community.aws.elb_application_lb_module.rst index 020d3b34212..cae74399a5d 100644 --- a/docs/community.aws.elb_application_lb_module.rst +++ b/docs/community.aws.elb_application_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -127,7 +127,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -160,7 +160,7 @@ Parameters -
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.
+
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
@@ -217,7 +217,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -256,25 +256,6 @@ Parameters
The number of seconds to wait before an idle connection is closed.
- - -
- ip_address_type - -
- string -
- - -
    Choices: -
  • ipv4
    • -
  • dualstack
    • -
- - -
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
- -
@@ -529,6 +510,7 @@ 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
@@ -658,7 +640,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -731,7 +713,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -779,9 +761,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 fcc2bc01b6b..a6a90f89ee5 100644 --- a/docs/community.aws.elb_classic_lb_info_module.rst +++ b/docs/community.aws.elb_classic_lb_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +176,7 @@ 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
@@ -208,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -242,9 +244,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 new file mode 100644 index 00000000000..85612a0453c --- /dev/null +++ b/docs/community.aws.elb_classic_lb_module.rst @@ -0,0 +1,843 @@ +.. _community.aws.elb_classic_lb_module: + + +**************************** +community.aws.elb_classic_lb +**************************** + +**Creates or destroys Amazon ELB.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Returns information about the load balancer. +- Will be marked changed when called only if state is changed. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 2.6 +- boto + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access_logs + +
+ dictionary +
+ 		+ +
An associative array of access logs configuration settings (see example).
+
+
+ aws_access_key + +
+ string +
+ 		+ +
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_ca_bundle + +
+ path +
+ 		+ +
The location of a CA Bundle to use when validating SSL certificates.
+
Only used for boto3 based modules.
+
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+
+
+ aws_config + +
+ dictionary +
+ 		+ +
A dictionary to modify the botocore configuration.
+ +
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+
+
+ aws_secret_key + +
+ string +
+ 		+ +
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
+
+
+ connection_draining_timeout + +
+ integer +
+ 		+ +
Wait a specified timeout allowing connections to drain before terminating an instance.
+
+
+ cross_az_load_balancing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distribute load across all configured Availability Zones.
+
Defaults to false.
+
+
+ debug_botocore_endpoint_logs + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+
+
+ ec2_url + +
+ string +
+ 		+ +
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
+
+
+ health_check + +
+ dictionary +
+ 		+ +
An associative array of health check configuration settings (see example).
+
+
+ idle_timeout + +
+ integer +
+ 		+ +
ELB connections from clients and to servers are timed out after this amount of time.
+
+
+ instance_ids + +
+ list + / elements=string +
+ 		+ +
List of instance ids to attach to this ELB.
+
+
+ listeners + +
+ list + / elements=dictionary +
+ 		+ +
List of ports/protocols for this ELB to listen on (see example).
+
+
+ name + +
+ string + / required +
+ 		+ +
The name of the ELB.
+
+
+ profile + +
+ 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
+
+
+ purge_instance_ids + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing instance ids on ELB that are not found in instance_ids.
+
+
+ purge_listeners + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Purge existing listeners on ELB that are not found in listeners.
+
+
+ purge_subnets + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing subnets on ELB that are not found in subnets.
+
+
+ purge_zones + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing availability zones on ELB that are not found in zones.
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ scheme + +
+ string +
+ 		+
    Choices: +
  • internal
    • +
  • internet-facing ←
    • +
+ 		+
The scheme to use when creating the ELB.
+
For a private VPC-visible ELB use internal.
+
If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must set wait=true.
+
+
+ security_group_ids + +
+ list + / elements=string +
+ 		+ +
A list of security groups to apply to the ELB.
+
+
+ security_group_names + +
+ list + / elements=string +
+ 		+ +
A list of security group names to apply to the ELB.
+
+
+ security_token + +
+ 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
+
+
+ state + +
+ string + / required +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Create or destroy the ELB.
+
+
+ stickiness + +
+ dictionary +
+ 		+ +
An associative array of stickiness policy settings. Policy will be applied to all listeners (see example).
+
+
+ subnets + +
+ list + / elements=string +
+ 		+ +
A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
+
+
+ tags + +
+ dictionary +
+ 		+ +
An associative array of tags. To delete all tags, supply an empty dict.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to false, SSL certificates will not be validated for boto versions >= 2.6.0.
+
+
+ wait + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
+
+
+ wait_timeout + +
+ integer +
+ 		+ Default:
60
+ 		+
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated. A maximum of 600 seconds (10 minutes) is allowed.
+
+
+ zones + +
+ list + / elements=string +
+ 		+ +
List of availability zones to enable on this ELB.
+
+
+ + +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_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 + + + +Examples +-------- + +.. code-block:: yaml + + # Note: None of these examples set aws_access_key, aws_secret_key, or region. + # It is assumed that their matching environment variables are set. + + # Basic provisioning example (non-VPC) + + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + proxy_protocol: True + - protocol: https + load_balancer_port: 443 + instance_protocol: http # optional, defaults to value of protocol setting + instance_port: 80 + # ssl certificate required for https or ssl + ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert" + delegate_to: localhost + + # Internal ELB example + + - community.aws.elb_classic_lb: + name: "test-vpc" + scheme: internal + state: present + instance_ids: + - i-abcd1234 + purge_instance_ids: true + subnets: + - subnet-abcd1234 + - subnet-1a2b3c4d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Configure a health check and the access logs + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + health_check: + ping_protocol: http # options are http, https, ssl, tcp + ping_port: 80 + ping_path: "/index.html" # not required for tcp or ssl + response_timeout: 5 # seconds + interval: 30 # seconds + unhealthy_threshold: 2 + healthy_threshold: 10 + access_logs: + interval: 5 # minutes (defaults to 60) + s3_location: "my-bucket" # This value is required if access_logs is set + s3_prefix: "logs" + delegate_to: localhost + + # Ensure ELB is gone + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + delegate_to: localhost + + # Ensure ELB is gone and wait for check (for default timeout) + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + delegate_to: localhost + + # Ensure ELB is gone and wait for check with timeout value + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + wait_timeout: 600 + delegate_to: localhost + + # Normally, this module will purge any listeners that exist on the ELB + # but aren't specified in the listeners parameter. If purge_listeners is + # false it leaves them alone + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_listeners: no + delegate_to: localhost + + # Normally, this module will leave availability zones that are enabled + # on the ELB alone. If purge_zones is true, then any extraneous zones + # will be removed + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_zones: yes + delegate_to: localhost + + # Creates a ELB and assigns a list of subnets to it. + - community.aws.elb_classic_lb: + state: present + name: 'New ELB' + security_group_ids: 'sg-123456, sg-67890' + region: us-west-2 + subnets: 'subnet-123456,subnet-67890' + purge_subnets: yes + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Create an ELB with connection draining, increased idle timeout and cross availability + # zone load balancing + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + connection_draining_timeout: 60 + idle_timeout: 300 + cross_az_load_balancing: "yes" + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Create an ELB with load balancer stickiness enabled + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: loadbalancer + enabled: yes + expiration: 300 + delegate_to: localhost + + # Create an ELB with application stickiness enabled + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: application + enabled: yes + cookie: SESSIONID + delegate_to: localhost + + # Create an ELB and add tags + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: + Name: "New ELB" + stack: "production" + client: "Bob" + delegate_to: localhost + + # Delete all tags from an ELB + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: {} + delegate_to: localhost + + + + +Status +------ + + +Authors +~~~~~~~ + +- Jim Dalton (@jsdalton) diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index 00248cbdebb..be68b327065 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -27,10 +27,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -56,7 +54,7 @@ Parameters -
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.
+
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
@@ -75,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +106,7 @@ Parameters -
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.
+
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
@@ -146,8 +144,7 @@ Parameters -
List of ELB names, required for registration.
-
The ec2_elbs fact should be used if there was a previous de-register.
+
List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
@@ -162,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -182,8 +179,7 @@ Parameters -
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled.
-
If enable_availability_zone=no, the task will fail if the availability zone is not enabled on the ELB.
+
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
@@ -214,6 +210,7 @@ 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
@@ -247,7 +244,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -270,7 +267,7 @@ Parameters -
Register or deregister the instance.
+
register or deregister the instance
@@ -289,7 +286,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -324,10 +321,7 @@ Parameters Default:
0
-
Number of seconds to wait for an instance to change state.
-
If wait_timeout=0 then this module may return an error if a transient error occurs.
-
If non-zero then any transient errors are ignored until the timeout is reached.
-
Ignored when wait=no.
+
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
@@ -339,9 +333,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 fee52ab88f8..79895efaac0 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -182,29 +182,10 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
- - -
- ip_address_type - -
- string -
- - -
    Choices: -
  • ipv4
    • -
  • dualstack
    • -
- - -
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
- -
@@ -388,6 +369,7 @@ 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
@@ -480,7 +462,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -572,7 +554,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -620,9 +602,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3d300df03d3..4ee35257c3c 100644 --- a/docs/community.aws.elb_target_group_info_module.rst +++ b/docs/community.aws.elb_target_group_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -162,7 +162,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,6 +209,7 @@ 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
@@ -242,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -280,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -292,9 +293,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9995592049d..7549b81d275 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,6 +329,7 @@ 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
@@ -410,7 +411,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -619,7 +620,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -682,9 +683,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 39b55cf4a69..53d29e3295c 100644 --- a/docs/community.aws.elb_target_info_module.rst +++ b/docs/community.aws.elb_target_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +195,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 450e470048f..f596429753d 100644 --- a/docs/community.aws.elb_target_module.rst +++ b/docs/community.aws.elb_target_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -162,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -178,6 +177,7 @@ 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
@@ -211,7 +211,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -371,7 +371,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -384,9 +384,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5f6f70fd960..4e9b5d6f4a2 100644 --- a/docs/community.aws.execute_lambda_module.rst +++ b/docs/community.aws.execute_lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -161,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -297,7 +298,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -345,9 +346,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 7363b72fa27..52d02622b65 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_cert_module.rst @@ -25,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -54,7 +52,7 @@ Parameters -
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.
+
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
@@ -73,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +104,7 @@ Parameters -
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.
+
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
@@ -194,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -289,6 +287,7 @@ 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
@@ -322,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +364,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -377,9 +376,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 90c97b2c894..2eb85c16334 100644 --- a/docs/community.aws.iam_group_module.rst +++ b/docs/community.aws.iam_group_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +193,7 @@ 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
@@ -264,7 +266,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -322,7 +324,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -334,9 +336,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d5f9878f4a3..56ed8f76cd9 100644 --- a/docs/community.aws.iam_managed_policy_module.rst +++ b/docs/community.aws.iam_managed_policy_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -262,6 +263,7 @@ 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
@@ -295,7 +297,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -336,7 +338,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -348,9 +350,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2d679b95a89..b76f802ef87 100644 --- a/docs/community.aws.iam_mfa_device_info_module.rst +++ b/docs/community.aws.iam_mfa_device_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -159,6 +160,7 @@ 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
@@ -192,7 +194,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 971d5afdcb3..be1e539d5d2 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -14,13 +14,6 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The iam module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`iam_user `, :ref:`iam_group `, :ref:`iam_role `, :ref:`iam_policy ` and :ref:`iam_managed_policy ` modules. - - Synopsis -------- @@ -32,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -102,7 +93,7 @@ Parameters -
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.
+
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
@@ -121,7 +112,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -154,7 +145,7 @@ Parameters -
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.
+
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
@@ -191,7 +182,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -339,6 +330,7 @@ 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
@@ -372,7 +364,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -468,7 +460,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -481,9 +473,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -594,10 +585,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.iam_password_policy_module.rst b/docs/community.aws.iam_password_policy_module.rst index 593be87d97f..e1bdb8ce9fe 100644 --- a/docs/community.aws.iam_password_policy_module.rst +++ b/docs/community.aws.iam_password_policy_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -73,7 +74,7 @@ Parameters -
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.
+
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
@@ -92,7 +93,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +126,7 @@ Parameters -
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.
+
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
@@ -162,7 +163,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -195,6 +196,7 @@ 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
@@ -358,7 +360,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -400,7 +402,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -412,9 +414,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1c3361febd1..6d06db1d93f 100644 --- a/docs/community.aws.iam_policy_info_module.rst +++ b/docs/community.aws.iam_policy_info_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -210,6 +209,7 @@ 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
@@ -243,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +277,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e5fc98f019e..f976ac1a4d0 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -246,6 +245,7 @@ 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
@@ -279,7 +279,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -340,7 +340,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -352,9 +352,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d7de4a0837d..2e3abc9fe1e 100644 --- a/docs/community.aws.iam_role_info_module.rst +++ b/docs/community.aws.iam_role_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +192,7 @@ 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
@@ -225,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +248,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -259,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b2f8568bf43..e81541d815a 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -69,7 +70,7 @@ Parameters -
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.
+
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
@@ -88,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +122,7 @@ Parameters -
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.
+
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
@@ -143,6 +144,7 @@ Parameters
Boundaries cannot be set on Instance Profiles, as such if this option is specified then create_instance_profile must be false.
This is intended for roles/users that have permissions to create new IAM objects.
+
Requires botocore 1.10.57 or above.

aliases: boundary_policy_arn
@@ -231,7 +233,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -314,6 +316,7 @@ 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
@@ -387,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -425,6 +428,7 @@ Parameters
Tag dict to apply to the queue.
+
Requires botocore 1.12.46 or above.
@@ -443,7 +447,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -455,9 +459,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 785b1509c4b..3e9ac69b646 100644 --- a/docs/community.aws.iam_saml_federation_module.rst +++ b/docs/community.aws.iam_saml_federation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -222,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -263,7 +264,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -275,9 +276,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1f81ea21f74..c41d2407cb4 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1ad22f8cc81..f33064c0dd6 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -238,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -260,7 +262,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -272,9 +274,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 806451fa983..de70f8358d3 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +193,7 @@ 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
@@ -245,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -287,7 +289,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -299,9 +301,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 51ed5640cb0..27b71b0b487 100644 --- a/docs/community.aws.kinesis_stream_module.rst +++ b/docs/community.aws.kinesis_stream_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -231,6 +231,7 @@ 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
@@ -282,7 +283,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -355,7 +356,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -402,9 +403,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6d0acd53328..c50bf63db31 100644 --- a/docs/community.aws.lambda_alias_module.rst +++ b/docs/community.aws.lambda_alias_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -222,6 +222,7 @@ 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
@@ -255,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -296,7 +297,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -308,9 +309,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 14c0f6d008c..9d10ac318e9 100644 --- a/docs/community.aws.lambda_event_module.rst +++ b/docs/community.aws.lambda_event_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +212,7 @@ 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
@@ -245,7 +246,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -379,7 +380,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -407,9 +408,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 417f3d17179..369bd9399be 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -32,9 +32,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -60,7 +60,7 @@ Parameters -
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.
+
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
@@ -79,7 +79,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -112,7 +112,7 @@ Parameters -
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.
+
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
@@ -149,7 +149,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,6 +196,7 @@ 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
@@ -252,7 +253,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -274,7 +275,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -286,9 +287,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2f08ea7159b..ce265e7087d 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -246,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +269,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -280,9 +281,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 682891507e9..7368c05fed4 100644 --- a/docs/community.aws.lambda_module.rst +++ b/docs/community.aws.lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -250,6 +250,7 @@ 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
@@ -365,7 +366,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -402,7 +403,7 @@ Parameters -
Tag dict to apply to the function.
+
tag dict to apply to the function (requires botocore 1.5.40 or above).
@@ -456,7 +457,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -520,9 +521,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ca1dd8a9309..6b9fdbf943b 100644 --- a/docs/community.aws.lambda_policy_module.rst +++ b/docs/community.aws.lambda_policy_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -86,7 +86,7 @@ Parameters -
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.
+
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
@@ -105,7 +105,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -138,7 +138,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +243,7 @@ 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
@@ -276,7 +277,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -364,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -391,9 +392,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 441529b5378..5ff6b603b43 100644 --- a/docs/community.aws.lightsail_module.rst +++ b/docs/community.aws.lightsail_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -317,7 +318,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -382,9 +383,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 530ac744f26..3e199320cb1 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 +- python >= 2.7 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +191,7 @@ 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
@@ -223,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2bb3a389893..e679974045b 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.5.0 +- botocore +- python >= 2.6 Parameters @@ -141,7 +142,7 @@ Parameters -
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.
+
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
@@ -160,7 +161,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -193,7 +194,7 @@ Parameters -
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.
+
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
@@ -472,7 +473,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -927,6 +928,7 @@ 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
@@ -1134,7 +1136,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1401,7 +1403,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -1448,9 +1450,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 76da476f977..c3391656668 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -14,20 +14,14 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The rds module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`rds_instance `, :ref:`rds_instance_info `, and :ref:`rds_snapshot `. - - Synopsis -------- - Creates, deletes, or modifies rds resources. - When creating an instance it can be either a new instance or a read-only replica of an existing instance. +- This module has a dependency on python-boto >= 2.5 and will soon be deprecated. - The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0). -- Please use the boto3 based :ref:`community.aws.rds_instance ` instead. +- Please use boto3 based :ref:`community.aws.rds_instance ` instead. @@ -35,10 +29,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -84,7 +76,7 @@ Parameters -
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.
+
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
@@ -103,7 +95,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -136,7 +128,7 @@ Parameters -
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.
+
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
@@ -301,7 +293,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -550,6 +542,7 @@ 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
@@ -616,7 +609,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -758,7 +751,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -843,9 +836,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -1707,10 +1699,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.rds_param_group_module.rst b/docs/community.aws.rds_param_group_module.rst index 9715206d56c..9905c5a88d8 100644 --- a/docs/community.aws.rds_param_group_module.rst +++ b/docs/community.aws.rds_param_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +243,7 @@ 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
@@ -295,7 +296,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -352,7 +353,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -364,9 +365,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 7e5c169f9fe..8835ebf4347 100644 --- a/docs/community.aws.rds_snapshot_info_module.rst +++ b/docs/community.aws.rds_snapshot_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -209,7 +209,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -225,6 +225,7 @@ 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
@@ -258,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -302,7 +303,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -314,9 +315,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 657b56b7165..95ec276a159 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_snapshot_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -243,7 +244,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -299,7 +300,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -346,9 +347,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2618eb29a14..3b624ccdb09 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +189,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +294,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 10e633cb2e0..f1ad74a43b6 100644 --- a/docs/community.aws.redshift_cross_region_snapshots_module.rst +++ b/docs/community.aws.redshift_cross_region_snapshots_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -177,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,6 +194,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -302,7 +304,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -314,9 +316,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6535817f66c..4d8230f0ea6 100644 --- a/docs/community.aws.redshift_info_module.rst +++ b/docs/community.aws.redshift_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +176,7 @@ 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
@@ -209,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c5bd313bacc..27742aa8b82 100644 --- a/docs/community.aws.redshift_module.rst +++ b/docs/community.aws.redshift_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -124,7 +124,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -157,7 +157,7 @@ Parameters -
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.
+
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
@@ -318,7 +318,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -531,6 +531,7 @@ 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
@@ -603,7 +604,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -679,7 +680,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -744,9 +745,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b007c1e9934..7f66c0334a7 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -25,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -54,7 +52,7 @@ Parameters -
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.
+
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
@@ -73,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +104,7 @@ Parameters -
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.
+
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
@@ -143,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -160,7 +158,6 @@ Parameters
Database subnet group description.
-
Required when state=present.

aliases: description
@@ -195,7 +192,6 @@ Parameters
List of subnet IDs that make up the cluster subnet group.
-
Required when state=present.

aliases: subnets
@@ -211,6 +207,7 @@ 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
@@ -244,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -286,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -298,9 +295,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3d29ebeb929..b4b25fada6b 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -26,10 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -232,6 +230,7 @@ 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
@@ -302,7 +301,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -381,7 +380,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -393,9 +392,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d81b24597e5..e44d3e25ed0 100644 --- a/docs/community.aws.route53_info_module.rst +++ b/docs/community.aws.route53_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -190,7 +189,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -314,6 +313,7 @@ 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
@@ -390,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -454,7 +454,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -466,9 +466,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 47e58e06062..8c08e3bff64 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -108,7 +109,7 @@ Parameters -
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.
+
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
@@ -127,7 +128,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -160,7 +161,7 @@ Parameters -
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.
+
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
@@ -197,7 +198,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -318,6 +319,7 @@ 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
@@ -383,7 +385,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -475,7 +477,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -587,9 +589,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f80f0e2a9ac..0af97d45d8f 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -174,7 +174,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,6 +206,7 @@ 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
@@ -239,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -280,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -338,9 +339,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0f62c6e343b..a801b0ded68 100644 --- a/docs/community.aws.s3_bucket_notification_module.rst +++ b/docs/community.aws.s3_bucket_notification_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -283,6 +283,7 @@ 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
@@ -316,7 +317,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -372,7 +373,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -385,9 +386,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6a940862780..6382c26d25c 100644 --- a/docs/community.aws.s3_lifecycle_module.rst +++ b/docs/community.aws.s3_lifecycle_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -291,6 +290,7 @@ 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
@@ -380,7 +380,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -513,7 +513,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -547,9 +547,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 67762810882..cba4b51503d 100644 --- a/docs/community.aws.s3_logging_module.rst +++ b/docs/community.aws.s3_logging_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -279,7 +279,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -291,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_metrics_configuration_module.rst b/docs/community.aws.s3_metrics_configuration_module.rst index 449fd5d9b1f..570d88bd6f3 100644 --- a/docs/community.aws.s3_metrics_configuration_module.rst +++ b/docs/community.aws.s3_metrics_configuration_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -221,6 +220,7 @@ 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
@@ -254,7 +254,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +295,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -310,9 +310,8 @@ Notes - To request metrics for the entire bucket, create a metrics configuration without a filter - Metrics configurations are necessary only to enable request metric, bucket-level daily storage metrics are always turned on - If parameters 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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 348639b2c2e..bc674a64e25 100644 --- a/docs/community.aws.s3_sync_module.rst +++ b/docs/community.aws.s3_sync_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- botocore +- python >= 2.6 +- python-dateutil Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -193,7 +195,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -358,6 +360,7 @@ 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
@@ -406,7 +409,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -454,7 +457,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -466,9 +469,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -488,11 +490,6 @@ Examples file_root: roles/s3/files/ storage_class: GLACIER - - name: basic individual file upload - community.aws.s3_sync: - bucket: tedder - file_root: roles/s3/files/file_name - - name: all the options community.aws.s3_sync: bucket: tedder diff --git a/docs/community.aws.s3_website_module.rst b/docs/community.aws.s3_website_module.rst index 90078b3afc3..356cf0315ca 100644 --- a/docs/community.aws.s3_website_module.rst +++ b/docs/community.aws.s3_website_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +189,7 @@ 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
@@ -237,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +296,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -307,9 +308,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 177cf3c3452..83d5165b902 100644 --- a/docs/community.aws.sns_module.rst +++ b/docs/community.aws.sns_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -68,7 +69,7 @@ Parameters -
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.
+
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
@@ -87,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +121,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -302,6 +303,7 @@ 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
@@ -335,7 +337,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -418,7 +420,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -430,9 +432,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 321a1b958ec..3cf7abcd32f 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- python >= 2.6 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -220,6 +219,7 @@ 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
@@ -272,7 +272,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -349,26 +349,6 @@ Parameters - - -
- topic_type - -
- string -
-
added in 2.0.0
- - -
    Choices: -
  • standard ←
    • -
  • fifo
    • -
- - -
The type of topic that should be created. Either Standard for FIFO (first-in, first-out)
- -
@@ -385,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -397,9 +377,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e32121739cb..341f9ca2fc2 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -287,6 +287,7 @@ 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
@@ -390,7 +391,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -427,7 +428,7 @@ Parameters -
Tag dict to apply to the queue.
+
Tag dict to apply to the queue (requires botocore 1.5.40 or above).
To remove all tags set tags={} and purge_tags=true.
@@ -447,7 +448,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -475,9 +476,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 bfab5056a22..16b197c2bce 100644 --- a/docs/community.aws.sts_assume_role_module.rst +++ b/docs/community.aws.sts_assume_role_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -235,6 +236,7 @@ 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
@@ -300,7 +302,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -322,7 +324,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -335,9 +337,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0a9b8e9c3a5..26dae630d73 100644 --- a/docs/community.aws.sts_session_token_module.rst +++ b/docs/community.aws.sts_session_token_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -203,6 +204,7 @@ 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
@@ -236,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -258,7 +260,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -271,9 +273,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_ip_set_info_module.rst b/docs/community.aws.wafv2_ip_set_info_module.rst index 4f654bf6060..204f6619644 100644 --- a/docs/community.aws.wafv2_ip_set_info_module.rst +++ b/docs/community.aws.wafv2_ip_set_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_ip_set_module.rst b/docs/community.aws.wafv2_ip_set_module.rst index 506e1b2e1e2..cd08ee1d1fd 100644 --- a/docs/community.aws.wafv2_ip_set_module.rst +++ b/docs/community.aws.wafv2_ip_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -175,7 +176,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -227,6 +228,7 @@ 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
@@ -299,7 +301,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -357,7 +359,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -369,9 +371,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_resources_info_module.rst b/docs/community.aws.wafv2_resources_info_module.rst index 934e20ed66a..3c11ea767b7 100644 --- a/docs/community.aws.wafv2_resources_info_module.rst +++ b/docs/community.aws.wafv2_resources_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_resources_module.rst b/docs/community.aws.wafv2_resources_module.rst index ab010c46476..5cce8c74359 100644 --- a/docs/community.aws.wafv2_resources_module.rst +++ b/docs/community.aws.wafv2_resources_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -69,7 +70,7 @@ Parameters -
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.
+
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
@@ -88,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +122,7 @@ Parameters -
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.
+
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
@@ -158,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +190,7 @@ 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
@@ -241,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +285,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -295,9 +297,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_rule_group_info_module.rst b/docs/community.aws.wafv2_rule_group_info_module.rst index 9af6fceb5db..9de423f1e64 100644 --- a/docs/community.aws.wafv2_rule_group_info_module.rst +++ b/docs/community.aws.wafv2_rule_group_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -269,7 +271,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -281,9 +283,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_rule_group_module.rst b/docs/community.aws.wafv2_rule_group_module.rst index 36094e45332..a158cbb7946 100644 --- a/docs/community.aws.wafv2_rule_group_module.rst +++ b/docs/community.aws.wafv2_rule_group_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -239,6 +240,7 @@ 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
@@ -346,7 +348,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -403,7 +405,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -415,9 +417,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_web_acl_info_module.rst b/docs/community.aws.wafv2_web_acl_info_module.rst index 761b4b9fd2c..0e1c329f840 100644 --- a/docs/community.aws.wafv2_web_acl_info_module.rst +++ b/docs/community.aws.wafv2_web_acl_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_web_acl_module.rst b/docs/community.aws.wafv2_web_acl_module.rst index 32324dcd9b2..a23a519e438 100644 --- a/docs/community.aws.wafv2_web_acl_module.rst +++ b/docs/community.aws.wafv2_web_acl_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -195,7 +196,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +244,7 @@ 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
@@ -431,7 +433,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -488,7 +490,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -500,9 +502,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 52f221bf07a..92e1c2419b5 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 2.0.0 +version: 1.5.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: '>=2.0.0' + amazon.aws: '>=1.5.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/meta/runtime.yml b/meta/runtime.yml index c1ca9228a31..7572647d422 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -35,7 +35,6 @@ action_groups: - elb_target_group_facts - iam_mfa_device_facts - iam_role_facts - - iam_cert_facts - iam_server_certificate_facts - lambda_facts - rds_instance_facts @@ -172,7 +171,6 @@ action_groups: - iam_role - iam_role_info - iam_saml_federation - - iam_server_certificate - iam_server_certificate_info - iam_user - iam_user_info @@ -450,7 +448,7 @@ plugin_routing: deprecation: removal_date: 2021-12-01 warning_text: >- - iam_cert_facts was renamed in Ansible 2.9 to iam_server_certificate_info. + iam_cert_facts was renamed in Ansible 2.9 to iam_cert_info. Please update your tasks. iam_mfa_device_facts: deprecation: @@ -464,13 +462,6 @@ plugin_routing: warning_text: >- iam_role_facts was renamed in Ansible 2.9 to iam_role_info. Please update your tasks. - iam_cert: - redirect: community.aws.iam_server_certificate - deprecation: - removal_version: 4.0.0 - warning_text: >- - iam_cert has been renamed to iam_server_certificate for consistency. - Please update your tasks. iam_server_certificate_facts: deprecation: removal_date: 2021-12-01 diff --git a/plugins/modules/aws_msk_cluster.py b/plugins/modules/aws_msk_cluster.py index d6cf35d3ba3..41f2dd62e44 100644 --- a/plugins/modules/aws_msk_cluster.py +++ b/plugins/modules/aws_msk_cluster.py @@ -544,6 +544,7 @@ def create_or_update_cluster(client, module): } }, "cluster_kafka_version": { + "botocore_version": "1.16.19", "current_value": cluster["CurrentBrokerSoftwareInfo"]["KafkaVersion"], "target_value": module.params.get("version"), "update_params": { diff --git a/plugins/modules/aws_msk_config.py b/plugins/modules/aws_msk_config.py index f1966847422..6258ae916f6 100644 --- a/plugins/modules/aws_msk_config.py +++ b/plugins/modules/aws_msk_config.py @@ -279,6 +279,9 @@ def main(): module = AnsibleAWSModule(argument_spec=module_args, supports_check_mode=True) + # Support for update_configuration and delete_configuration added in 1.17.48 + module.require_botocore_at_least('1.17.48') + client = module.client("kafka", retry_decorator=AWSRetry.jittered_backoff()) if module.params["state"] == "present": diff --git a/plugins/modules/cloudfront_distribution.py b/plugins/modules/cloudfront_distribution.py index 80ac6dcec4b..9887a8d373a 100644 --- a/plugins/modules/cloudfront_distribution.py +++ b/plugins/modules/cloudfront_distribution.py @@ -1591,8 +1591,7 @@ def __init__(self, module): 'TLSv1_2016', 'TLSv1.1_2016', 'TLSv1.2_2018', - 'TLSv1.2_2019', - 'TLSv1.2_2021' + 'TLSv1.2_2019' ]) self.__valid_viewer_certificate_certificate_sources = set([ 'cloudfront', diff --git a/plugins/modules/dynamodb_table.py b/plugins/modules/dynamodb_table.py index 7a3add3727a..b23c443cac9 100644 --- a/plugins/modules/dynamodb_table.py +++ b/plugins/modules/dynamodb_table.py @@ -19,8 +19,8 @@ requirements: - python >= 3.6 - boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.13.0 +- botocore >= 1.16.0 options: state: description: diff --git a/plugins/modules/ec2_eip.py b/plugins/modules/ec2_eip.py index 927d31551b7..adf6f0bda41 100644 --- a/plugins/modules/ec2_eip.py +++ b/plugins/modules/ec2_eip.py @@ -344,11 +344,10 @@ def address_is_associated_with_device(ec2, module, address, device_id, is_instan def allocate_address(ec2, module, domain, reuse_existing_ip_allowed, check_mode, tag_dict=None, public_ipv4_pool=None): """ Allocate a new elastic IP address (when needed) and return it """ - if not domain: - domain = 'standard' - if reuse_existing_ip_allowed: filters = [] + if not domain: + domain = 'standard' filters.append({'Name': 'domain', "Values": [domain]}) if tag_dict is not None: diff --git a/plugins/modules/elasticache_subnet_group.py b/plugins/modules/elasticache_subnet_group.py index eda678205d0..44a3e39ae6f 100644 --- a/plugins/modules/elasticache_subnet_group.py +++ b/plugins/modules/elasticache_subnet_group.py @@ -12,36 +12,34 @@ version_added: 1.0.0 short_description: manage ElastiCache subnet groups description: - - Creates, modifies, and deletes ElastiCache subnet groups. + - Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. options: state: description: - Specifies whether the subnet should be present or absent. + required: true choices: [ 'present' , 'absent' ] - default: 'present' type: str name: description: - Database subnet group identifier. - - This value is automatically converted to lowercase. required: true type: str description: description: - - ElastiCache subnet group description. - - When not provided defaults to I(name) on subnet group creation. + - ElastiCache subnet group description. Only set when a new group is added. type: str subnets: description: - List of subnet IDs that make up the ElastiCache subnet group. - - At least one subnet must be provided when creating an ElastiCache subnet group. type: list elements: str -author: - - "Tim Mahoney (@timmahoney)" +author: "Tim Mahoney (@timmahoney)" extends_documentation_fragment: - - amazon.aws.aws - - amazon.aws.ec2 +- amazon.aws.aws +- amazon.aws.ec2 +requirements: +- boto >= 2.49.0 ''' EXAMPLES = r''' @@ -60,195 +58,87 @@ name: norwegian-blue ''' -RETURN = r''' -cache_subnet_group: - description: Description of the Elasticache Subnet Group. - returned: always - type: dict - contains: - arn: - description: The Amazon Resource Name (ARN) of the cache subnet group. - returned: when the subnet group exists - type: str - sample: arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue - description: - description: The description of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: My Fancy Ex Parrot Subnet Group - name: - description: The name of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: norwegian-blue - vpc_id: - description: The VPC ID of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: norwegian-blue - subnet_ids: - description: The IDs of the subnets beloging to the cache subnet group. - returned: when the cache subnet group exists - type: list - elements: str - sample: - - subnet-aaaaaaaa - - subnet-bbbbbbbb -''' - try: - import botocore + import boto + from boto.elasticache import connect_to_region + from boto.exception import BotoServerError except ImportError: - pass # Handled by AnsibleAWSModule - -from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict + pass # Handled by HAS_BOTO +from ansible.module_utils._text import to_native from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry - - -def get_subnet_group(name): - try: - groups = client.describe_cache_subnet_groups( - aws_retry=True, - CacheSubnetGroupName=name, - )['CacheSubnetGroups'] - except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): - return None - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to describe subnet group") - - if not groups: - return None - - if len(groups) > 1: - module.fail_aws( - msg="Found multiple matches for subnet group", - cache_subnet_groups=camel_dict_to_snake_dict(groups), - ) - - subnet_group = camel_dict_to_snake_dict(groups[0]) - - subnet_group['name'] = subnet_group['cache_subnet_group_name'] - subnet_group['description'] = subnet_group['cache_subnet_group_description'] - - subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) - subnet_group['subnet_ids'] = subnet_ids - - return subnet_group - - -def create_subnet_group(name, description, subnets): - - if not subnets: - module.fail_json(msg='At least one subnet must be provided when creating a subnet group') - - if module.check_mode: - return True - - try: - if not description: - description = name - client.create_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - CacheSubnetGroupDescription=description, - SubnetIds=subnets, - ) - return True - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to create subnet group") - - -def update_subnet_group(subnet_group, name, description, subnets): - update_params = dict() - if description and subnet_group['description'] != description: - update_params['CacheSubnetGroupDescription'] = description - if subnets: - old_subnets = set(subnet_group['subnet_ids']) - new_subnets = set(subnets) - if old_subnets != new_subnets: - update_params['SubnetIds'] = list(subnets) - - if not update_params: - return False - - if module.check_mode: - return True - - try: - client.modify_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - **update_params, - ) - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to update subnet group") - - return True - - -def delete_subnet_group(name): - - if module.check_mode: - return True - - try: - client.delete_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - ) - return True - except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): - # AWS is "eventually consistent", cope with the race conditions where - # deletion hadn't completed when we ran describe - return False - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to delete subnet group") +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info def main(): argument_spec = dict( - state=dict(default='present', choices=['present', 'absent']), + state=dict(required=True, choices=['present', 'absent']), name=dict(required=True), description=dict(required=False), subnets=dict(required=False, type='list', elements='str'), ) + module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - global module - global client - - module = AnsibleAWSModule( - argument_spec=argument_spec, - supports_check_mode=True, - ) + if not HAS_BOTO: + module.fail_json(msg='boto required for this module') state = module.params.get('state') - name = module.params.get('name').lower() - description = module.params.get('description') - subnets = module.params.get('subnets') + group_name = module.params.get('name').lower() + group_description = module.params.get('description') + group_subnets = module.params.get('subnets') or {} - client = module.client('elasticache', retry_decorator=AWSRetry.jittered_backoff()) + if state == 'present': + for required in ['name', 'description', 'subnets']: + if not module.params.get(required): + module.fail_json(msg=str("Parameter %s required for state='present'" % required)) + else: + for not_allowed in ['description', 'subnets']: + if module.params.get(not_allowed): + module.fail_json(msg=str("Parameter %s not allowed for state='absent'" % not_allowed)) - subnet_group = get_subnet_group(name) - changed = False + # Retrieve any AWS settings from the environment. + region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module) - if state == 'present': - if not subnet_group: - result = create_subnet_group(name, description, subnets) - changed |= result + if not region: + module.fail_json(msg=str("Either region or AWS_REGION or EC2_REGION environment variable or boto config aws_region or ec2_region must be set.")) + + """Get an elasticache connection""" + try: + conn = connect_to_region(region_name=region, **aws_connect_kwargs) + except boto.exception.NoAuthHandlerFound as e: + module.fail_json(msg=to_native(e)) + + try: + changed = False + exists = False + + try: + matching_groups = conn.describe_cache_subnet_groups(group_name, max_records=100) + exists = len(matching_groups) > 0 + except BotoServerError as e: + if e.error_code != 'CacheSubnetGroupNotFoundFault': + module.fail_json(msg=e.error_message) + + if state == 'absent': + if exists: + conn.delete_cache_subnet_group(group_name) + changed = True else: - result = update_subnet_group(subnet_group, name, description, subnets) - changed |= result - subnet_group = get_subnet_group(name) - else: - if subnet_group: - result = delete_subnet_group(name) - changed |= result - subnet_group = None + if not exists: + new_group = conn.create_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) + changed = True + else: + changed_group = conn.modify_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) + changed = True + + except BotoServerError as e: + if e.error_message != 'No modifications were requested.': + module.fail_json(msg=e.error_message) + else: + changed = False - module.exit_json(changed=changed, cache_subnet_group=subnet_group) + module.exit_json(changed=changed) if __name__ == '__main__': diff --git a/plugins/modules/elb_target_group.py b/plugins/modules/elb_target_group.py index 9a740422293..45649e7e651 100644 --- a/plugins/modules/elb_target_group.py +++ b/plugins/modules/elb_target_group.py @@ -161,23 +161,6 @@ - The identifier of the virtual private cloud (VPC). Required when I(state) is C(present). required: false type: str - preserve_client_ip_enabled: - description: - - Indicates whether client IP preservation is enabled. - - The default is disabled if the target group type is C(ip) address and the target group protocol is C(tcp) or C(tls). - Otherwise, the default is enabled. Client IP preservation cannot be disabled for C(udp) and C(tcp_udp) target groups. - - I(preserve_client_ip_enabled) is supported only by Network Load Balancers. - type: bool - required: false - version_added: 2.1.0 - proxy_protocol_v2_enabled: - description: - - Indicates whether Proxy Protocol version 2 is enabled. - - The value is C(true) or C(false). - - I(proxy_protocol_v2_enabled) is supported only by Network Load Balancers. - type: bool - required: false - version_added: 2.1.0 wait: description: - Whether or not to wait for the target group. @@ -491,8 +474,6 @@ def create_or_update_target_group(connection, module): stickiness_type = module.params.get("stickiness_type") stickiness_app_cookie_duration = module.params.get("stickiness_app_cookie_duration") stickiness_app_cookie_name = module.params.get("stickiness_app_cookie_name") - preserve_client_ip_enabled = module.params.get("preserve_client_ip_enabled") - proxy_protocol_v2_enabled = module.params.get("proxy_protocol_v2_enabled") health_option_keys = [ "health_check_path", "health_check_protocol", "health_check_interval", "health_check_timeout", @@ -782,13 +763,6 @@ def create_or_update_target_group(connection, module): if stickiness_app_cookie_duration is not None: if str(stickiness_app_cookie_duration) != current_tg_attributes['stickiness_app_cookie_duration_seconds']: update_attributes.append({'Key': 'stickiness.app_cookie.duration_seconds', 'Value': str(stickiness_app_cookie_duration)}) - if preserve_client_ip_enabled is not None: - if target_type not in ('udp', 'tcp_udp'): - if str(preserve_client_ip_enabled).lower() != current_tg_attributes.get('preserve_client_ip_enabled'): - update_attributes.append({'Key': 'preserve_client_ip.enabled', 'Value': str(preserve_client_ip_enabled).lower()}) - if proxy_protocol_v2_enabled is not None: - if str(proxy_protocol_v2_enabled).lower() != current_tg_attributes.get('proxy_protocol_v2_enabled'): - update_attributes.append({'Key': 'proxy_protocol_v2.enabled', 'Value': str(proxy_protocol_v2_enabled).lower()}) if update_attributes: try: @@ -878,8 +852,6 @@ def main(): targets=dict(type='list', elements='dict'), unhealthy_threshold_count=dict(type='int'), vpc_id=dict(), - preserve_client_ip_enabled=dict(type='bool'), - proxy_protocol_v2_enabled=dict(type='bool'), wait_timeout=dict(type='int', default=200), wait=dict(type='bool', default=False) ) diff --git a/plugins/modules/iam_server_certificate.py b/plugins/modules/iam_cert.py similarity index 88% rename from plugins/modules/iam_server_certificate.py rename to plugins/modules/iam_cert.py index 5402b22d126..fbe984670aa 100644 --- a/plugins/modules/iam_server_certificate.py +++ b/plugins/modules/iam_cert.py @@ -20,7 +20,7 @@ DOCUMENTATION = ''' --- -module: iam_server_certificate +module: iam_cert version_added: 1.0.0 short_description: Manage server certificates for use on ELBs and CloudFront description: @@ -56,23 +56,17 @@ cert_chain: description: - The path to, or content of, the CA certificate chain in PEM encoded format. - - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str cert: description: - The path to, or content of the certificate body in PEM encoded format. - - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str key: description: - The path to, or content of the private key in PEM encoded format. - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str dup_ok: description: @@ -91,7 +85,7 @@ EXAMPLES = ''' - name: Basic server certificate upload from local file - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present cert: "{{ lookup('file', 'path/to/cert') }}" @@ -99,7 +93,7 @@ cert_chain: "{{ lookup('file', 'path/to/certchain') }}" - name: Basic server certificate upload - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present cert: path/to/cert @@ -107,7 +101,7 @@ cert_chain: path/to/certchain - name: Server certificate upload using key string - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present path: "/a/cert/path/" @@ -116,7 +110,7 @@ cert_chain: body_of_myverytrustedchain - name: Basic rename of existing certificate - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl new_name: new_very_ssl state: present @@ -237,31 +231,16 @@ def load_data(cert, key, cert_chain): if cert and os.path.isfile(cert): with open(cert, 'r') as cert_fh: cert = cert_fh.read().rstrip() - module.deprecate( - 'Passing a file name as the cert argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') if key and os.path.isfile(key): with open(key, 'r') as key_fh: key = key_fh.read().rstrip() - module.deprecate( - 'Passing a file name as the key argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') if cert_chain and os.path.isfile(cert_chain): with open(cert_chain, 'r') as cert_chain_fh: cert_chain = cert_chain_fh.read() - module.deprecate( - 'Passing a file name as the cert_chain argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') return cert, key, cert_chain def main(): - - global module - argument_spec = dict( state=dict(required=True, choices=['present', 'absent']), name=dict(required=True), diff --git a/plugins/modules/rds_instance_info.py b/plugins/modules/rds_instance_info.py index 13609972c17..fba7804012a 100644 --- a/plugins/modules/rds_instance_info.py +++ b/plugins/modules/rds_instance_info.py @@ -234,11 +234,6 @@ returned: always type: str sample: '2017-10-10T04:00:07.434000+00:00' - iops: - description: The Provisioned IOPS value for the DB instance. - returned: always - type: int - sample: 1000 kms_key_id: description: KMS Key ID returned: always diff --git a/plugins/modules/redshift_subnet_group.py b/plugins/modules/redshift_subnet_group.py index 89e8bfa8042..fa210a5bee4 100644 --- a/plugins/modules/redshift_subnet_group.py +++ b/plugins/modules/redshift_subnet_group.py @@ -9,6 +9,8 @@ DOCUMENTATION = r''' --- +author: + - "Jens Carl (@j-carl), Hothead Games Inc." module: redshift_subnet_group version_added: 1.0.0 short_description: manage Redshift cluster subnet groups @@ -17,33 +19,32 @@ options: state: description: - - Specifies whether the subnet group should be present or absent. - default: 'present' + - Specifies whether the subnet should be present or absent. + required: true choices: ['present', 'absent' ] type: str - name: + group_name: description: - Cluster subnet group name. required: true - aliases: ['group_name'] + aliases: ['name'] type: str - description: + group_description: description: - - Cluster subnet group description. - aliases: ['group_description'] + - Database subnet group description. + aliases: ['description'] type: str - subnets: + group_subnets: description: - List of subnet IDs that make up the cluster subnet group. - - At least one subnet must be provided when creating a cluster subnet group. - aliases: ['group_subnets'] + aliases: ['subnets'] type: list elements: str extends_documentation_fragment: - amazon.aws.aws - amazon.aws.ec2 -author: - - "Jens Carl (@j-carl), Hothead Games Inc." +requirements: +- boto >= 2.49.0 ''' EXAMPLES = r''' @@ -63,209 +64,113 @@ ''' RETURN = r''' -cluster_subnet_group: - description: A dictionary containing information about the Redshift subnet group. +group: + description: dictionary containing all Redshift subnet group information returned: success - type: dict + type: complex contains: name: - description: Name of the Redshift subnet group. - returned: when the cache subnet group exists + description: name of the Redshift subnet group + returned: success type: str sample: "redshift_subnet_group_name" vpc_id: - description: Id of the VPC where the subnet is located. - returned: when the cache subnet group exists + description: Id of the VPC where the subnet is located + returned: success type: str sample: "vpc-aabb1122" - description: - description: The description of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: Redshift subnet - subnet_ids: - description: The IDs of the subnets beloging to the Redshift subnet group. - returned: when the cache subnet group exists - type: list - elements: str - sample: - - subnet-aaaaaaaa - - subnet-bbbbbbbb ''' try: - import botocore + import boto + import boto.redshift except ImportError: - pass # Handled by AnsibleAWSModule - -from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict + pass # Handled by HAS_BOTO from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict - - -def get_subnet_group(name): - try: - groups = client.describe_cluster_subnet_groups( - aws_retry=True, - ClusterSubnetGroupName=name, - )['ClusterSubnetGroups'] - except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): - return None - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to describe subnet group") - - if not groups: - return None - - if len(groups) > 1: - module.fail_aws( - msg="Found multiple matches for subnet group", - cluster_subnet_groups=camel_dict_to_snake_dict(groups), - ) - - # No support for managing tags yet, but make sure that we don't need to - # change the return value structure after it's been available in a release. - tags = boto3_tag_list_to_ansible_dict(groups[0]['Tags']) - - subnet_group = camel_dict_to_snake_dict(groups[0]) - - subnet_group['tags'] = tags - subnet_group['name'] = subnet_group['cluster_subnet_group_name'] - - subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) - subnet_group['subnet_ids'] = subnet_ids - - return subnet_group - - -def create_subnet_group(name, description, subnets): - - if not subnets: - module.fail_json(msg='At least one subnet must be provided when creating a subnet group') - - if module.check_mode: - return True - - try: - if not description: - description = name - client.create_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - Description=description, - SubnetIds=subnets, - ) - return True - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to create subnet group") - - -def update_subnet_group(subnet_group, name, description, subnets): - update_params = dict() - if description and subnet_group['description'] != description: - update_params['Description'] = description - if subnets: - old_subnets = set(subnet_group['subnet_ids']) - new_subnets = set(subnets) - if old_subnets != new_subnets: - update_params['SubnetIds'] = list(subnets) - - if not update_params: - return False - - if module.check_mode: - return True - - # Description is optional, SubnetIds is not - if 'SubnetIds' not in update_params: - update_params['SubnetIds'] = subnet_group['subnet_ids'] - - try: - client.modify_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - **update_params, - ) - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to update subnet group") - - return True - - -def delete_subnet_group(name): - - if module.check_mode: - return True - - try: - client.delete_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - ) - return True - except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): - # AWS is "eventually consistent", cope with the race conditions where - # deletion hadn't completed when we ran describe - return False - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to delete subnet group") +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import connect_to_aws +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info def main(): argument_spec = dict( - state=dict(default='present', choices=['present', 'absent']), - name=dict(required=True, aliases=['group_name']), - description=dict(required=False, aliases=['group_description']), - subnets=dict(required=False, aliases=['group_subnets'], type='list', elements='str'), + state=dict(required=True, choices=['present', 'absent']), + group_name=dict(required=True, aliases=['name']), + group_description=dict(required=False, aliases=['description']), + group_subnets=dict(required=False, aliases=['subnets'], type='list', elements='str'), ) + module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - global module - global client - - module = AnsibleAWSModule( - argument_spec=argument_spec, - supports_check_mode=True, - ) + if not HAS_BOTO: + module.fail_json(msg='boto v2.9.0+ required for this module') state = module.params.get('state') - name = module.params.get('name') - description = module.params.get('description') - subnets = module.params.get('subnets') - - client = module.client('redshift', retry_decorator=AWSRetry.jittered_backoff()) - - subnet_group = get_subnet_group(name) - changed = False + group_name = module.params.get('group_name') + group_description = module.params.get('group_description') + group_subnets = module.params.get('group_subnets') if state == 'present': - if not subnet_group: - result = create_subnet_group(name, description, subnets) - changed |= result - else: - result = update_subnet_group(subnet_group, name, description, subnets) - changed |= result - subnet_group = get_subnet_group(name) + for required in ('group_name', 'group_description', 'group_subnets'): + if not module.params.get(required): + module.fail_json(msg=str("parameter %s required for state='present'" % required)) else: - if subnet_group: - result = delete_subnet_group(name) - changed |= result - subnet_group = None + for not_allowed in ('group_description', 'group_subnets'): + if module.params.get(not_allowed): + module.fail_json(msg=str("parameter %s not allowed for state='absent'" % not_allowed)) - compat_results = dict() - if subnet_group: - compat_results['group'] = dict( - name=subnet_group['name'], - vpc_id=subnet_group['vpc_id'], - ) + region, ec2_url, aws_connect_params = get_aws_connection_info(module) + if not region: + module.fail_json(msg=str("Region must be specified as a parameter, in EC2_REGION or AWS_REGION environment variables or in boto configuration file")) - module.exit_json( - changed=changed, - cluster_subnet_group=subnet_group, - **compat_results, - ) + # Connect to the Redshift endpoint. + try: + conn = connect_to_aws(boto.redshift, region, **aws_connect_params) + except boto.exception.JSONResponseError as e: + module.fail_json(msg=str(e)) + + try: + changed = False + exists = False + group = None + + try: + matching_groups = conn.describe_cluster_subnet_groups(group_name, max_records=100) + exists = len(matching_groups) > 0 + except boto.exception.JSONResponseError as e: + if e.body['Error']['Code'] != 'ClusterSubnetGroupNotFoundFault': + # if e.code != 'ClusterSubnetGroupNotFoundFault': + module.fail_json(msg=str(e)) + + if state == 'absent': + if exists: + conn.delete_cluster_subnet_group(group_name) + changed = True + + else: + if not exists: + new_group = conn.create_cluster_subnet_group(group_name, group_description, group_subnets) + group = { + 'name': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['ClusterSubnetGroupName'], + 'vpc_id': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['VpcId'], + } + else: + changed_group = conn.modify_cluster_subnet_group(group_name, group_subnets, description=group_description) + group = { + 'name': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['ClusterSubnetGroupName'], + 'vpc_id': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['VpcId'], + } + + changed = True + + except boto.exception.JSONResponseError as e: + module.fail_json(msg=str(e)) + + module.exit_json(changed=changed, group=group) if __name__ == '__main__': diff --git a/plugins/modules/route53.py b/plugins/modules/route53.py index d4fe99531c0..d1391cfac58 100644 --- a/plugins/modules/route53.py +++ b/plugins/modules/route53.py @@ -606,7 +606,6 @@ def main(): 'TTL': ttl_in, 'ResourceRecords': [dict(Value=value) for value in value_in], 'HealthCheckId': health_check_in, - 'SetIdentifier': identifier_in, }) if alias_in: diff --git a/plugins/modules/sns_topic.py b/plugins/modules/sns_topic.py index 37cf573ce58..dd5af417bab 100644 --- a/plugins/modules/sns_topic.py +++ b/plugins/modules/sns_topic.py @@ -49,73 +49,6 @@ description: - Delivery policy to apply to the SNS topic. type: dict - suboptions: - http: - description: - - Delivery policy for HTTP(S) messages. - - See U(https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) - for more information. - type: dict - required: false - suboptions: - disableSubscriptionOverrides: - description: - - Applies this policy to all subscriptions, even if they have their own policies. - type: bool - required: false - defaultThrottlePolicy: - description: - - Throttle the rate of messages sent to subsriptions. - type: dict - suboptions: - maxReceivesPerSecond: - description: - - The maximum number of deliveries per second per subscription. - type: int - required: true - required: false - defaultHealthyRetryPolicy: - description: - - Retry policy for HTTP(S) messages. - type: dict - required: true - suboptions: - minDelayTarget: - description: - - The minimum delay for a retry. - type: int - required: true - maxDelayTarget: - description: - - The maximum delay for a retry. - type: int - required: true - numRetries: - description: - - The total number of retries. - type: int - required: true - numMaxDelayRetries: - description: - - The number of retries with the maximum delay between them. - type: int - required: true - numMinDelayRetries: - description: - - The number of retries with just the minimum delay between them. - type: int - required: true - numNoDelayRetries: - description: - - The number of retries to be performmed immediately. - type: int - required: true - backoffFunction: - description: - - The function for backoff between retries. - type: str - required: true - choices: ['arithmetic', 'exponential', 'geometric', 'linear'] subscriptions: description: - List of subscriptions to apply to the topic. Note that AWS requires @@ -292,12 +225,8 @@ except ImportError: pass # handled by AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.core import scrub_none_parameters -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import camel_dict_to_snake_dict +from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule, is_boto3_error_code +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies, AWSRetry, camel_dict_to_snake_dict class SnsTopicManager(object): @@ -322,7 +251,7 @@ def __init__(self, self.state = state self.display_name = display_name self.policy = policy - self.delivery_policy = scrub_none_parameters(delivery_policy) if delivery_policy else None + self.delivery_policy = delivery_policy self.subscriptions = subscriptions self.subscriptions_existing = [] self.subscriptions_deleted = [] @@ -566,39 +495,13 @@ def get_info(self): def main(): - - # We're kinda stuck with CamelCase here, it would be nice to switch to - # snake_case, but we'd need to purge out the alias entries - http_retry_args = dict( - minDelayTarget=dict(type='int', required=True), - maxDelayTarget=dict(type='int', required=True), - numRetries=dict(type='int', required=True), - numMaxDelayRetries=dict(type='int', required=True), - numMinDelayRetries=dict(type='int', required=True), - numNoDelayRetries=dict(type='int', required=True), - backoffFunction=dict(type='str', required=True, choices=['arithmetic', 'exponential', 'geometric', 'linear']), - ) - http_delivery_args = dict( - defaultHealthyRetryPolicy=dict(type='dict', required=True, options=http_retry_args), - disableSubscriptionOverrides=dict(type='bool', required=False), - defaultThrottlePolicy=dict( - type='dict', required=False, - options=dict( - maxReceivesPerSecond=dict(type='int', required=True), - ), - ), - ) - delivery_args = dict( - http=dict(type='dict', required=False, options=http_delivery_args), - ) - argument_spec = dict( name=dict(required=True), topic_type=dict(type='str', default='standard', choices=['standard', 'fifo']), state=dict(default='present', choices=['present', 'absent']), display_name=dict(), policy=dict(type='dict'), - delivery_policy=dict(type='dict', options=delivery_args), + delivery_policy=dict(type='dict'), subscriptions=dict(default=[], type='list', elements='dict'), purge_subscriptions=dict(type='bool', default=True), ) diff --git a/requirements.txt b/requirements.txt index 3685e404330..0d58b96112d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,3 @@ -# When updating the minimal requirements please also update -# - tests/unit/constraints.txt -# - tests/integration/constraints.txt -# - tests/integration/targets/setup_botocore_pip -botocore>=1.18.0 -boto3>=1.15.0 -# Final released version boto>=2.49.0 +botocore>=1.16.0 +boto3>=1.13.0 diff --git a/test-requirements.txt b/test-requirements.txt index 77c76b86509..3d217284154 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,3 @@ -botocore -boto3 -boto - coverage==4.5.4 placebo mock @@ -12,5 +8,3 @@ pytest-mock netaddr # Sometimes needed where we don't have features we need in modules awscli -# Used for comparing SSH Public keys to the Amazon fingerprints -pycrypto diff --git a/tests/config.yml b/tests/config.yml deleted file mode 100644 index 5112f726881..00000000000 --- a/tests/config.yml +++ /dev/null @@ -1,2 +0,0 @@ -modules: - python_requires: '>=3.6' diff --git a/tests/integration/constraints.txt b/tests/integration/constraints.txt index bd95eb26733..c105f290280 100644 --- a/tests/integration/constraints.txt +++ b/tests/integration/constraints.txt @@ -1,7 +1,3 @@ -# Specifically run tests against the oldest versions that we support -boto3==1.15.0 -botocore==1.18.0 +boto3 >= 1.9.250, <= 1.15.18 # minimum version that supports botocore 1.13.3, max that will work with ansible 2.9's other constraints +botocore<1.19.0,>=1.13.3 # adds support for ECR image scanning -# AWS CLI has `botocore==` dependencies, provide the one that matches botocore -# to avoid needing to download over a years worth of awscli wheels. -awscli==1.18.141 diff --git a/tests/integration/requirements.txt b/tests/integration/requirements.txt index 6e870975a35..2fb8f547d8a 100644 --- a/tests/integration/requirements.txt +++ b/tests/integration/requirements.txt @@ -1,12 +1,5 @@ -# Our code is based on the AWS SDKs -boto -boto3 -botocore - # netaddr is needed for ansible.netcommon.ipv6 netaddr virtualenv -# Sometimes needed where we don't have features we need in modules -awscli -# Used for comparing SSH Public keys to the Amazon fingerprints -pycrypto +boto3 +botocore diff --git a/tests/integration/targets/aws_msk_cluster/tasks/main.yml b/tests/integration/targets/aws_msk_cluster/tasks/main.yml index a3049dad0b4..9ace1814f81 100644 --- a/tests/integration/targets/aws_msk_cluster/tasks/main.yml +++ b/tests/integration/targets/aws_msk_cluster/tasks/main.yml @@ -40,38 +40,60 @@ - set_fact: subnet_ids: '{{ subnets | community.general.json_query("results[].subnet.id") | list }}' + - pip: + name: virtualenv + - set_fact: + virtualenv: "{{ remote_tmp_dir }}/virtualenv" + virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" + - set_fact: + virtualenv_interpreter: "{{ virtualenv }}/bin/python" + - pip: + name: + - 'boto3>=1.13.0' + - 'botocore==1.17.48' + - 'coverage<5' + virtualenv: '{{ virtualenv }}' + virtualenv_command: '{{ virtualenv_command }}' + virtualenv_site_packages: no + # ============================================================ - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: - - "{{ msk_version }}" - register: msk_config + - name: Wrap test in virtualenv + vars: + ansible_python_interpreter: "{{ virtualenv }}/bin/python" + block: + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: + - "{{ msk_version }}" + register: msk_config - - name: create tests - include_tasks: test_create.yml + - name: create tests + include_tasks: test_create.yml - - name: update tests - include_tasks: test_update.yml + - name: update tests + include_tasks: test_update.yml - - name: delete tests - include_tasks: test_delete.yml + - name: delete tests + include_tasks: test_delete.yml - always: + always: - - name: delete msk cluster - aws_msk_cluster: - name: "{{ msk_cluster_name }}" - state: absent - wait: true - ignore_errors: yes + - name: delete msk cluster + aws_msk_cluster: + name: "{{ msk_cluster_name }}" + state: absent + wait: true + ignore_errors: yes - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes + + always: - name: remove subnets ec2_vpc_subnet: diff --git a/tests/integration/targets/aws_msk_config/tasks/main.yml b/tests/integration/targets/aws_msk_config/tasks/main.yml index cef9e1dfc90..d29631c1930 100644 --- a/tests/integration/targets/aws_msk_config/tasks/main.yml +++ b/tests/integration/targets/aws_msk_config/tasks/main.yml @@ -9,140 +9,161 @@ collections: - amazon.aws block: - - name: create msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be created - assert: - that: - - msk_config is changed - - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration is created - assert: - that: - - msk_config is changed - - - name: create msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: validate return values - assert: - that: - - msk_config.revision == 1 - - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" - - "'auto.create.topics.enable=True' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" - - - name: update msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: update msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: validate return values (update) - assert: - that: - - msk_config.revision == 2 - - "'auto.create.topics.enable=True' not in msk_config.server_properties" - - "'num.io.threads=8' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" - - - name: update msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: delete msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - always: - - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + + - pip: + name: virtualenv + - set_fact: + virtualenv: "{{ remote_tmp_dir }}/virtualenv" + virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" + - set_fact: + virtualenv_interpreter: "{{ virtualenv }}/bin/python" + - pip: + name: + - 'boto3>=1.13.0' + - 'botocore==1.17.48' + - 'coverage<5' + virtualenv: '{{ virtualenv }}' + virtualenv_command: '{{ virtualenv_command }}' + virtualenv_site_packages: no + + - name: Wrap test in virtualenv + vars: + ansible_python_interpreter: "{{ virtualenv }}/bin/python" + block: + - name: create msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be created + assert: + that: + - msk_config is changed + + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration is created + assert: + that: + - msk_config is changed + + - name: create msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: validate return values + assert: + that: + - msk_config.revision == 1 + - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" + - "'auto.create.topics.enable=True' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" + + - name: update msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: update msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: validate return values (update) + assert: + that: + - msk_config.revision == 2 + - "'auto.create.topics.enable=True' not in msk_config.server_properties" + - "'num.io.threads=8' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" + + - name: update msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: delete msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + always: + + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes diff --git a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml index 77c193043a9..8dd14bfbd42 100644 --- a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml +++ b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml @@ -10,7 +10,7 @@ virtualenv_interpreter: "{{ virtualenv }}/bin/python" - pip: name: - - 'boto3>=1.15.0' + - 'boto3>=1.13.0' - 'botocore==1.18.11' - 'coverage<5' virtualenv: '{{ virtualenv }}' diff --git a/tests/integration/targets/dynamodb_table/aliases b/tests/integration/targets/dynamodb_table/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/dynamodb_table/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/dynamodb_table/defaults/main.yml b/tests/integration/targets/dynamodb_table/defaults/main.yml deleted file mode 100644 index 47fc4243153..00000000000 --- a/tests/integration/targets/dynamodb_table/defaults/main.yml +++ /dev/null @@ -1,47 +0,0 @@ ---- -table_name: '{{ resource_prefix }}' - -table_index: 'id' -table_index_type: 'NUMBER' - -range_index: 'variety' -range_index_type: 'STRING' - -indexes: - - name: NamedIndex - type: global_include - hash_key_name: idx - range_key_name: create_time - includes: - - other_field - - other_field2 - read_capacity: 10 - write_capacity: 10 - - name: AnotherIndex - type: global_all - hash_key_name: foo - range_key_name: bar - includes: - - another_field - - another_field2 - read_capacity: 5 - write_capacity: 5 - - -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/dynamodb_table/meta/main.yml b/tests/integration/targets/dynamodb_table/meta/main.yml deleted file mode 100644 index 07faa217762..00000000000 --- a/tests/integration/targets/dynamodb_table/meta/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -dependencies: - - prepare_tests diff --git a/tests/integration/targets/dynamodb_table/tasks/main.yml b/tests/integration/targets/dynamodb_table/tasks/main.yml deleted file mode 100644 index 938351f5625..00000000000 --- a/tests/integration/targets/dynamodb_table/tasks/main.yml +++ /dev/null @@ -1,733 +0,0 @@ ---- -# dynamodb_table integration tests -# -# Current module limitations: -# - changed very flakey -# - various parameters have defaults set so reset undefined value -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================== - - - name: Create table - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - check_mode: True - - - name: Check results - Create table - check_mode - assert: - that: - - create_table is successful - - create_table is changed - - '"hash_key_name" in create_table' - - - name: Create table - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - - - name: Check results - Create table - assert: - that: - - create_table is successful - - create_table is changed - - '"hash_key_name" in create_table' - - '"hash_key_type" in create_table' - - '"indexes" in create_table' - - '"range_key_name" in create_table' - - '"range_key_type" in create_table' - - '"read_capacity" in create_table' - - '"region" in create_table' - - '"table_name" in create_table' - - '"table_status" in create_table' - - '"write_capacity" in create_table' - - create_table.hash_key_name == table_index - - create_table.hash_key_type == table_index_type - - create_table.indexes | length == 0 - - create_table.range_key_name is none - - create_table.range_key_type == "STRING" - - create_table.read_capacity == 1 - - create_table.table_name == table_name - - create_table.write_capacity == 1 - - - name: Create table - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - check_mode: True - - - name: Check results - Create table - idempotent - check_mode - assert: - that: - - create_table is successful - - create_table is not changed - - - name: Create table - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - - - name: Check results - Create table - idempotent - assert: - that: - - create_table is successful - - create_table is not changed - - '"hash_key_name" in create_table' - - '"hash_key_type" in create_table' - - '"indexes" in create_table' - - '"range_key_name" in create_table' - - '"range_key_type" in create_table' - - '"read_capacity" in create_table' - - '"region" in create_table' - - '"table_name" in create_table' - - '"table_status" in create_table' - - '"write_capacity" in create_table' - - create_table.hash_key_name == table_index - - create_table.hash_key_type == table_index_type - - create_table.indexes | length == 0 - - create_table.range_key_name is none - - create_table.range_key_type == "STRING" - - create_table.read_capacity == 1 - - create_table.table_name == table_name - - create_table.write_capacity == 1 - - # ============================================== - - - name: Tag table - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - check_mode: True - - - name: Check results - Tag table - check_mode - assert: - that: - - tag_table is successful - # XXX bug updating (just) tags doesn't return 'changed' - # - tag_table is changed - - - name: Tag table - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - - - name: Check results - Tag table - assert: - that: - - tag_table is successful - # XXX bug updating (just) tags doesn't return 'changed' - # - tag_table is changed - - '"hash_key_name" in tag_table' - - '"hash_key_type" in tag_table' - - '"indexes" in tag_table' - - '"range_key_name" in tag_table' - - '"range_key_type" in tag_table' - - '"read_capacity" in tag_table' - - '"region" in tag_table' - - '"table_name" in tag_table' - - '"table_status" in tag_table' - - '"write_capacity" in tag_table' - # XXX Bug - returns none when not actively set - # - tag_table.hash_key_name == table_index - # XXX Bug - returns string when not actively set - #- tag_table.hash_key_type == table_index_type - - tag_table.indexes | length == 0 - - tag_table.range_key_name is none - - tag_table.range_key_type == "STRING" - - tag_table.read_capacity == 1 - - tag_table.table_name == table_name - - tag_table.write_capacity == 1 - - tag_table.tags == tags_default - - - name: Tag table - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - check_mode: True - - - name: Check results - Tag table - idempotent - check_mode - assert: - that: - - tag_table is successful - - tag_table is not changed - - - name: Tag table - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - - - name: Check results - Tag table - idempotent - assert: - that: - - tag_table is successful - - tag_table is not changed - - '"hash_key_name" in tag_table' - - '"hash_key_type" in tag_table' - - '"indexes" in tag_table' - - '"range_key_name" in tag_table' - - '"range_key_type" in tag_table' - - '"read_capacity" in tag_table' - - '"region" in tag_table' - - '"table_name" in tag_table' - - '"table_status" in tag_table' - - '"write_capacity" in tag_table' - # XXX Bug - returns none when not actively set - # - tag_table.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - tag_table.hash_key_type == table_index_type - - tag_table.indexes | length == 0 - - tag_table.range_key_name is none - - tag_table.range_key_type == "STRING" - - tag_table.read_capacity == 1 - - tag_table.table_name == table_name - - tag_table.write_capacity == 1 - - tag_table.tags == tags_default - - # ============================================== - - - name: Update table read capacity - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - check_mode: True - - - name: Check results - Update table read capacity - check_mode - assert: - that: - - update_read is successful - - update_read is changed - - - name: Update table read capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - - - name: Check results - Update table read capacity - assert: - that: - - update_read is successful - - update_read is changed - - '"hash_key_name" in update_read' - - '"hash_key_type" in update_read' - - '"indexes" in update_read' - - '"range_key_name" in update_read' - - '"range_key_type" in update_read' - - '"read_capacity" in update_read' - - '"region" in update_read' - - '"table_name" in update_read' - - '"table_status" in update_read' - - '"write_capacity" in update_read' - # XXX Bug - returns none when not actively set - # - update_read.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_read.hash_key_type == table_index_type - - update_read.indexes | length == 0 - - update_read.range_key_name is none - - update_read.range_key_type == "STRING" - - update_read.read_capacity == 3 - - update_read.table_name == table_name - - update_read.write_capacity == 1 - # Tags are only returned when tagging - # - update_read.tags == tags_default - - - name: Update table read capacity - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - check_mode: True - - - name: Check results - Update table read capacity - idempotent - check_mode - assert: - that: - - update_read is successful - # XXX Bug - returns changed - # - update_read is not changed - - - name: Update table read capacity - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - # Can result in ResourceInUseException - change in flight - until: update_read is successful - retries: 15 - delay: 10 - - - name: Check results - Update table read capacity - idempotent - assert: - that: - - update_read is successful - - update_read is not changed - - '"hash_key_name" in update_read' - - '"hash_key_type" in update_read' - - '"indexes" in update_read' - - '"range_key_name" in update_read' - - '"range_key_type" in update_read' - - '"read_capacity" in update_read' - - '"region" in update_read' - - '"table_name" in update_read' - - '"table_status" in update_read' - - '"write_capacity" in update_read' - # XXX Bug - returns none when not actively set - # - update_read.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_read.hash_key_type == table_index_type - - update_read.indexes | length == 0 - - update_read.range_key_name is none - - update_read.range_key_type == "STRING" - - update_read.read_capacity == 3 - - update_read.table_name == table_name - - update_read.write_capacity == 1 - # Tags are only returned when tagging - # - update_read.tags == tags_default - - # ============================================== - - - name: Update table write capacity - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - check_mode: True - - - name: Check results - Update table write capacity - check_mode - assert: - that: - - update_write is successful - - update_write is changed - - - name: Update table write capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - - - name: Check results - Update table write capacity - assert: - that: - - update_write is successful - - update_write is changed - - '"hash_key_name" in update_write' - - '"hash_key_type" in update_write' - - '"indexes" in update_write' - - '"range_key_name" in update_write' - - '"range_key_type" in update_write' - - '"read_capacity" in update_write' - - '"region" in update_write' - - '"table_name" in update_write' - - '"table_status" in update_write' - - '"write_capacity" in update_write' - # XXX Bug - returns none when not actively set - # - update_write.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_write.hash_key_type == table_index_type - - update_write.indexes | length == 0 - - update_write.range_key_name is none - - update_write.range_key_type == "STRING" - # XXX Bug - gets reset to 1 because a default was set - # - update_write.read_capacity == 3 - - update_write.table_name == table_name - - update_write.write_capacity == 3 - # Tags are only returned when tagging - # - update_write.tags == tags_default - - - name: Update table write capacity - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - check_mode: True - - - name: Check results - Update table write capacity - idempotent - check_mode - assert: - that: - - update_write is successful - # XXX Bug - returns changed - # - update_write is not changed - - - name: Update table write capacity - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - # Can result in ResourceInUseException - change in flight - until: update_write is successful - retries: 15 - delay: 10 - - - name: Check results - Update table write capacity - idempotent - assert: - that: - - update_write is successful - # XXX Bug - returns changed - # - update_write is not changed - - '"hash_key_name" in update_write' - - '"hash_key_type" in update_write' - - '"indexes" in update_write' - - '"range_key_name" in update_write' - - '"range_key_type" in update_write' - - '"read_capacity" in update_write' - - '"region" in update_write' - - '"table_name" in update_write' - - '"table_status" in update_write' - - '"write_capacity" in update_write' - # XXX Bug - returns none when not actively set - # - update_write.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_write.hash_key_type == table_index_type - - update_write.indexes | length == 0 - - update_write.range_key_name is none - - update_write.range_key_type == "STRING" - # XXX Bug - gets reset to 1 because a default was set - # - update_write.read_capacity == 3 - - update_write.table_name == table_name - - update_write.write_capacity == 3 - # Tags are only returned when tagging - # - update_write.tags == tags_default - - # ============================================== - - - name: Update table add range index - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - check_mode: True - - - name: Check results - Update table add range index - check_mode - assert: - that: - - update_range_index is successful - - update_range_index is changed - - - name: Update table write capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - - - name: Check results - Update table add range index - assert: - that: - - update_range_index is successful - - update_range_index is changed - - '"hash_key_name" in update_range_index' - - '"hash_key_type" in update_range_index' - - '"indexes" in update_range_index' - - '"range_key_name" in update_range_index' - - '"range_key_type" in update_range_index' - - '"read_capacity" in update_range_index' - - '"region" in update_range_index' - - '"table_name" in update_range_index' - - '"table_status" in update_range_index' - - '"write_capacity" in update_range_index' - # XXX Bug - returns none when not actively set - # - update_range_index.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_range_index.hash_key_type == table_index_type - - update_range_index.indexes | length == 0 - - update_range_index.range_key_name == range_index - - update_range_index.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.read_capacity == 3 - - update_range_index.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.write_capacity == 3 - # Tags are only returned when tagging - # - update_range_index.tags == tags_default - - - name: Update table add range index - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - check_mode: True - - - name: Check results - Update table add range index - idempotent - check_mode - assert: - that: - - update_range_index is successful - # XXX Bug - returns changed - # - update_range_index is not changed - - - name: Update table add range index - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - # Can result in ResourceInUseException - change in flight - until: update_range_index is successful - retries: 15 - delay: 10 - - - name: Check results - Update table add range index - idempotent - assert: - that: - - update_range_index is successful - # XXX Bug - returns changed - # - update_range_index is not changed - - '"hash_key_name" in update_range_index' - - '"hash_key_type" in update_range_index' - - '"indexes" in update_range_index' - - '"range_key_name" in update_range_index' - - '"range_key_type" in update_range_index' - - '"read_capacity" in update_range_index' - - '"region" in update_range_index' - - '"table_name" in update_range_index' - - '"table_status" in update_range_index' - - '"write_capacity" in update_range_index' - # XXX Bug - returns none when not actively set - # - update_range_index.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_range_index.hash_key_type == table_index_type - - update_range_index.indexes | length == 0 - - update_range_index.range_key_name == range_index - - update_range_index.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.read_capacity == 3 - - update_range_index.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.write_capacity == 3 - # Tags are only returned when tagging - # - update_range_index.tags == tags_default - - # ============================================== - - - name: Update table add indexes - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - check_mode: True - - - name: Check results - Update table add indexes - check_mode - assert: - that: - - update_indexes is successful - - update_indexes is changed - - - name: Update table add indexes - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - # Can result in LimitExceededException - change in flight - until: update_indexes is successful - retries: 45 - delay: 10 - - - name: Check results - Update table add indexes - assert: - that: - - update_indexes is successful - - update_indexes is changed - - '"hash_key_name" in update_indexes' - - '"hash_key_type" in update_indexes' - - '"indexes" in update_indexes' - - '"range_key_name" in update_indexes' - - '"range_key_type" in update_indexes' - - '"read_capacity" in update_indexes' - - '"region" in update_indexes' - - '"table_name" in update_indexes' - - '"table_status" in update_indexes' - - '"write_capacity" in update_indexes' - # XXX Bug - returns none when not actively set - # - update_indexes.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_indexes.hash_key_type == table_index_type - - update_indexes.indexes | length == 2 - # XXX Bug - returns none when not actively set - # - update_indexes.range_key_name == range_index - # XXX Bug - returns string when not actively set - # - update_indexes.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.read_capacity == 3 - - update_indexes.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.write_capacity == 3 - # Tags are only returned when tagging - # - update_indexes.tags == tags_default - - - name: Update table add indexes - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - check_mode: True - - - name: Check results - Update table add indexes - idempotent - check_mode - assert: - that: - - update_indexes is successful - # XXX Bug - returns changed - # - update_indexes is not changed - - - name: Update table add indexes - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - # Can result in LimitExceededException - change in flight - until: update_indexes is successful - retries: 45 - delay: 10 - - - name: Check results - Update table add indexes - idempotent - assert: - that: - - update_indexes is successful - # XXX Bug - returns changed - # - update_indexes is not changed - - '"hash_key_name" in update_indexes' - - '"hash_key_type" in update_indexes' - - '"indexes" in update_indexes' - - '"range_key_name" in update_indexes' - - '"range_key_type" in update_indexes' - - '"read_capacity" in update_indexes' - - '"region" in update_indexes' - - '"table_name" in update_indexes' - - '"table_status" in update_indexes' - - '"write_capacity" in update_indexes' - # XXX Bug - returns none when not actively set - # - update_indexes.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_indexes.hash_key_type == table_index_type - - update_indexes.indexes | length == 2 - # XXX Bug - returns none when not actively set - # - update_indexes.range_key_name == range_index - # XXX Bug - returns string when not actively set - # - update_indexes.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.read_capacity == 3 - - update_indexes.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.write_capacity == 3 - # Tags are only returned when tagging - # - update_indexes.tags == tags_default - - # ============================================== - - - name: Delete table - check_mode - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - check_mode: True - - - name: Check results - Delete table - check_mode - assert: - that: - - delete_table is successful - - delete_table is changed - - - name: Delete table - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Updates don't support waiting yet, so retry until successful - until: delete_table is successful - retries: 45 - delay: 10 - - - name: Check results - Delete table - assert: - that: - - delete_table is successful - - delete_table is changed - - - name: Delete table - idempotent - check_mode - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - check_mode: True - - - name: Check results - Delete table - idempotent - check_mode - assert: - that: - - delete_table is successful - # XXX bug - returns changed - # - delete_table is not changed - - - name: Delete table - idempotent - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Deletion doesn't support waiting yet, so retry until successful - until: delete_table is successful - retries: 45 - delay: 10 - - - name: Check results - Delete table - idempotent - assert: - that: - - delete_table is successful - - delete_table is not changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Clean up table - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Can result in LimitExceededException or ResourceInUseException - changes in flight - until: delete_table is successful - retries: 40 - delay: 10 diff --git a/tests/integration/targets/ec2_eip/tasks/main.yml b/tests/integration/targets/ec2_eip/tasks/main.yml index 9f03f5b5647..83093572697 100644 --- a/tests/integration/targets/ec2_eip/tasks/main.yml +++ b/tests/integration/targets/ec2_eip/tasks/main.yml @@ -662,25 +662,6 @@ state: absent name: '{{ resource_prefix }}-vpc' cidr_block: '{{ vpc_cidr }}' - - - name: Create an EIP outside a VPC - ec2_eip: - state: present - in_vpc: '{{ omit }}' - register: unbound_eip - - assert: - that: - - unbound_eip is successful - - unbound_eip is changed - - name: Release EIP - ec2_eip: - state: absent - public_ip: '{{ unbound_eip.public_ip }}' - register: release_unbound_eip - - assert: - that: - - release_unbound_eip is successful - - release_unbound_eip is changed # ===================================================== always: - name: Cleanup instance (by id) @@ -754,12 +735,6 @@ public_ip: '{{ no_tagged_eip.public_ip }}' when: no_tagged_eip is changed ignore_errors: true - - name: Cleanup unbound_eip - ec2_eip: - state: absent - public_ip: '{{ unbound_eip.public_ip }}' - when: unbound_eip is changed - ignore_errors: true - name: Cleanup VPC ec2_vpc_net: state: absent diff --git a/tests/integration/targets/elasticache/aliases b/tests/integration/targets/elasticache/aliases index 5ee1d22add8..88ef7754817 100644 --- a/tests/integration/targets/elasticache/aliases +++ b/tests/integration/targets/elasticache/aliases @@ -3,3 +3,5 @@ unstable cloud/aws + +elasticache_subnet_group diff --git a/tests/integration/targets/elasticache_subnet_group/aliases b/tests/integration/targets/elasticache_subnet_group/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/elasticache_subnet_group/defaults/main.yml b/tests/integration/targets/elasticache_subnet_group/defaults/main.yml deleted file mode 100644 index ea8921880a9..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/defaults/main.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- -availability_zone: '{{ ec2_availability_zone_names[0] }}' - -vpc_name: '{{ resource_prefix }}' -subnet_name_a: '{{ resource_prefix }}-a' -subnet_name_b: '{{ resource_prefix }}-b' -subnet_name_c: '{{ resource_prefix }}-c' -subnet_name_d: '{{ resource_prefix }}-d' - -vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' -subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' -subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' -subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' -subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' - -subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' -subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' - -group_name: '{{ resource_prefix }}' -description_default: 'Subnet Description' -description_updated: 'updated subnet description' - -# Tagging not currently supported, planned with boto3 upgrade -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/elasticache_subnet_group/meta/main.yml b/tests/integration/targets/elasticache_subnet_group/meta/main.yml deleted file mode 100644 index 930e8622824..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_ec2_facts diff --git a/tests/integration/targets/elasticache_subnet_group/tasks/main.yml b/tests/integration/targets/elasticache_subnet_group/tasks/main.yml deleted file mode 100644 index 5814f9dc90d..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/tasks/main.yml +++ /dev/null @@ -1,681 +0,0 @@ ---- -# elasticache_subnet_group integration tests -# -# Current module limitations: -# - check_mode not supported -# - Tagging not supported -# - Returned values *very* limited (almost none) -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================================ - - - name: Create Subnet Group with no subnets - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - check_mode: True - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - check_mode - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateCacheSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"SubnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - - name: Create Subnet Group with no subnets - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateCacheSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"SubnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - # ============================================================ - # Setup infra needed for tests - - name: create a VPC - ec2_vpc_net: - state: present - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - tags: - TestPrefix: '{{ resource_prefix }}' - register: vpc_result - - - name: create subnets - ec2_vpc_subnet: - state: present - cidr: '{{ item.cidr }}' - az: '{{ item.zone }}' - vpc_id: '{{ vpc_result.vpc.id }}' - tags: - Name: '{{ item.name }}' - TestPrefix: '{{ resource_prefix }}' - register: vpc_subnet_create - loop: - - name: '{{ subnet_name_a }}' - cidr: '{{ subnet_cidr_a }}' - zone: '{{ subnet_zone_a }}' - - name: '{{ subnet_name_b }}' - cidr: '{{ subnet_cidr_b }}' - zone: '{{ subnet_zone_b }}' - - name: '{{ subnet_name_c }}' - cidr: '{{ subnet_cidr_c }}' - zone: '{{ subnet_zone_c }}' - - name: '{{ subnet_name_d }}' - cidr: '{{ subnet_cidr_d }}' - zone: '{{ subnet_zone_d }}' - - - name: Store IDs of subnets and VPC - set_fact: - vpc_id: '{{ vpc_result.vpc.id }}' - subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' - subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' - subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' - subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' - - # ============================================================ - - - name: Create Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: create_group - - - name: Check result - Create Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == description_default - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - - name: Create Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: create_group - - - name: Check result - Create Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == description_default - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Update Subnet Group Description - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - check_mode: True - register: update_description - - - name: Check result - Update Subnet Group Description - check_mode - assert: - that: - - update_description is successful - - update_description is changed - - - name: Update Subnet Group Description - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - assert: - that: - - update_description is successful - - update_description is changed - - '"cache_subnet_group" in update_description' - - '"arn" in update_description.cache_subnet_group' - - '"description" in update_description.cache_subnet_group' - - '"name" in update_description.cache_subnet_group' - - '"subnet_ids" in update_description.cache_subnet_group' - - '"vpc_id" in update_description.cache_subnet_group' - - update_description.cache_subnet_group.description == description_updated - - update_description.cache_subnet_group.name == group_name - - subnet_id_a in update_description.cache_subnet_group.subnet_ids - - subnet_id_b in update_description.cache_subnet_group.subnet_ids - - subnet_id_c not in update_description.cache_subnet_group.subnet_ids - - subnet_id_d not in update_description.cache_subnet_group.subnet_ids - - update_description.cache_subnet_group.vpc_id == vpc_id - - update_description.cache_subnet_group.arn.startswith('arn:') - - update_description.cache_subnet_group.arn.endswith(group_name) - - - name: Update Subnet Group Description - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - check_mode: True - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - check_mode - assert: - that: - - update_description is successful - - update_description is not changed - - - name: Update Subnet Group Description - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - assert: - that: - - update_description is successful - - update_description is not changed - - '"cache_subnet_group" in update_description' - - '"arn" in update_description.cache_subnet_group' - - '"description" in update_description.cache_subnet_group' - - '"name" in update_description.cache_subnet_group' - - '"subnet_ids" in update_description.cache_subnet_group' - - '"vpc_id" in update_description.cache_subnet_group' - - update_description.cache_subnet_group.description == description_updated - - update_description.cache_subnet_group.name == group_name - - subnet_id_a in update_description.cache_subnet_group.subnet_ids - - subnet_id_b in update_description.cache_subnet_group.subnet_ids - - subnet_id_c not in update_description.cache_subnet_group.subnet_ids - - subnet_id_d not in update_description.cache_subnet_group.subnet_ids - - update_description.cache_subnet_group.vpc_id == vpc_id - - update_description.cache_subnet_group.arn.startswith('arn:') - - update_description.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Update Subnet Group subnets - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - check_mode: True - register: update_subnets - - - name: Check result - Update Subnet Group subnets - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is changed - - - name: Update Subnet Group subnets - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - assert: - that: - - update_subnets is successful - - update_subnets is changed - - '"cache_subnet_group" in update_subnets' - - '"arn" in update_subnets.cache_subnet_group' - - '"description" in update_subnets.cache_subnet_group' - - '"name" in update_subnets.cache_subnet_group' - - '"subnet_ids" in update_subnets.cache_subnet_group' - - '"vpc_id" in update_subnets.cache_subnet_group' - - update_subnets.cache_subnet_group.description == description_updated - - update_subnets.cache_subnet_group.name == group_name - - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids - - update_subnets.cache_subnet_group.vpc_id == vpc_id - - update_subnets.cache_subnet_group.arn.startswith('arn:') - - update_subnets.cache_subnet_group.arn.endswith(group_name) - - - name: Update Subnet Group subnets - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - check_mode: True - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - - name: Update Subnet Group subnets - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - '"cache_subnet_group" in update_subnets' - - '"arn" in update_subnets.cache_subnet_group' - - '"description" in update_subnets.cache_subnet_group' - - '"name" in update_subnets.cache_subnet_group' - - '"subnet_ids" in update_subnets.cache_subnet_group' - - '"vpc_id" in update_subnets.cache_subnet_group' - - update_subnets.cache_subnet_group.description == description_updated - - update_subnets.cache_subnet_group.name == group_name - - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids - - update_subnets.cache_subnet_group.vpc_id == vpc_id - - update_subnets.cache_subnet_group.arn.startswith('arn:') - - update_subnets.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Delete Subnet Group - check_mode - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - check_mode: True - register: delete_group - - - name: Check result - Delete Subnet Group - check_mode - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - check_mode: True - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - check_mode - assert: - that: - - delete_group is not changed - - - name: Delete Subnet Group - idempotency - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - assert: - that: - - delete_group is not changed - - # ============================================================ - - - name: Create minimal Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - check_mode: True - register: create_group - - - name: Check result - Create minimal Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create minimal Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == group_name - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b not in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - - name: Create minimal Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - check_mode: True - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create minimal Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == group_name - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b not in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Full Update Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: update_complex - - - name: Check result - Full Update Subnet Group - check_mode - assert: - that: - - update_complex is successful - - update_complex is changed - - - name: Update Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - assert: - that: - - update_complex is successful - - update_complex is changed - - '"cache_subnet_group" in update_complex' - - '"arn" in update_complex.cache_subnet_group' - - '"description" in update_complex.cache_subnet_group' - - '"name" in update_complex.cache_subnet_group' - - '"subnet_ids" in update_complex.cache_subnet_group' - - '"vpc_id" in update_complex.cache_subnet_group' - - update_complex.cache_subnet_group.description == description_updated - - update_complex.cache_subnet_group.name == group_name - - subnet_id_a in update_complex.cache_subnet_group.subnet_ids - - subnet_id_b in update_complex.cache_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids - - update_complex.cache_subnet_group.vpc_id == vpc_id - - update_complex.cache_subnet_group.arn.startswith('arn:') - - update_complex.cache_subnet_group.arn.endswith(group_name) - - - name: Full Update Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - check_mode - assert: - that: - - update_complex is successful - - update_complex is not changed - - - name: Full Update Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - assert: - that: - - update_complex is successful - - update_complex is not changed - - '"cache_subnet_group" in update_complex' - - '"arn" in update_complex.cache_subnet_group' - - '"description" in update_complex.cache_subnet_group' - - '"name" in update_complex.cache_subnet_group' - - '"subnet_ids" in update_complex.cache_subnet_group' - - '"vpc_id" in update_complex.cache_subnet_group' - - update_complex.cache_subnet_group.description == description_updated - - update_complex.cache_subnet_group.name == group_name - - subnet_id_a in update_complex.cache_subnet_group.subnet_ids - - subnet_id_b in update_complex.cache_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids - - update_complex.cache_subnet_group.vpc_id == vpc_id - - update_complex.cache_subnet_group.arn.startswith('arn:') - - update_complex.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - ignore_errors: True - - - name: tidy up subnet - ec2_vpc_subnet: - state: absent - cidr: '{{ item }}' - vpc_id: '{{ vpc_result.vpc.id }}' - loop: - - '{{ subnet_cidr_a }}' - - '{{ subnet_cidr_b }}' - - '{{ subnet_cidr_c }}' - - '{{ subnet_cidr_d }}' - ignore_errors: True - - - name: tidy up VPC - ec2_vpc_net: - state: absent - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - ignore_errors: True diff --git a/tests/integration/targets/elb_target/tasks/ec2_target.yml b/tests/integration/targets/elb_target/tasks/ec2_target.yml index f350672cafe..108ffa4d30b 100644 --- a/tests/integration/targets/elb_target/tasks/ec2_target.yml +++ b/tests/integration/targets/elb_target/tasks/ec2_target.yml @@ -17,6 +17,7 @@ - set_fact: ec2_ami_image: '{{ ec2_amis.images[0].image_id }}' + - name: set up testing VPC ec2_vpc_net: name: "{{ resource_prefix }}-vpc" @@ -118,33 +119,6 @@ tags: Description: "Created by {{ resource_prefix }}" - - name: set up testing target group for NLB (type=instance) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: set up testing target group for NLB (type=instance) - assert: - that: - - result.changed - - '"health_check_port" in result' - - result.port == 80 - - '"health_check_protocol" in result' - - result.health_check_protocol == 'TCP' - - '"tags" in result' - - '"target_group_arn" in result' - - result.target_group_name == "{{ tg_name }}-nlb" - - result.target_type == 'instance' - - result.vpc_id == '{{ vpc.vpc.id }}' - - name: set up ec2 instance to use as a target ec2_instance: name: "{{ resource_prefix }}-inst" @@ -187,98 +161,6 @@ TargetGroupName: "{{ tg_name }}-used" state: present - - name: create a network load balancer - elb_network_lb: - name: "{{ lb_name }}-nlb" - subnets: - - "{{ subnet_1.subnet.id }}" - - "{{ subnet_2.subnet.id }}" - listeners: - - Protocol: TCP - Port: 80 - DefaultActions: - - Type: forward - TargetGroupName: "{{ tg_name }}-nlb" - state: present - register: result - - - name: create a netwok load balancer - assert: - that: - - result.changed - - '"created_time" in result' - - '"load_balancer_arn" in result' - - '"tags" in result' - - result.type == 'network' - - result.vpc_id == '{{ vpc.vpc.id }}' - - - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - preserve_client_ip_enabled: false - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) - assert: - that: - - result.changed - - result.preserve_client_ip_enabled == 'false' - - result.proxy_protocol_v2_enabled == 'false' - - - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - proxy_protocol_v2_enabled: true - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) - assert: - that: - - result.changed - - result.proxy_protocol_v2_enabled == 'true' - - result.preserve_client_ip_enabled == 'false' - - - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - preserve_client_ip_enabled: false - proxy_protocol_v2_enabled: true - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) - assert: - that: - - not result.changed - - result.proxy_protocol_v2_enabled == 'true' - - result.preserve_client_ip_enabled == 'false' - # ============================================================ - name: @@ -481,26 +363,6 @@ - "{{ tg_tcpudp_name }}" ignore_errors: true - - name: remove tcp testing target groups - elb_target_group: - name: "{{ item }}" - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: absent - target_type: instance - tags: - Description: "Created by {{ resource_prefix }}" - Protocol: "UDP" - wait: true - wait_timeout: 400 - register: removed - retries: 10 - until: removed is not failed - with_items: - - "{{ tg_name }}-nlb" - ignore_errors: true - - name: remove application load balancer elb_application_lb: name: "{{ lb_name }}" @@ -523,26 +385,6 @@ until: removed is not failed ignore_errors: true - - name: remove network load balancer - elb_network_lb: - name: "{{ lb_name }}-nlb" - subnets: - - "{{ subnet_1.subnet.id }}" - - "{{ subnet_2.subnet.id }}" - listeners: - - Protocol: TCP - Port: 80 - DefaultActions: - - Type: forward - TargetGroupName: "{{ tg_name }}-nlb" - state: absent - wait: true - wait_timeout: 400 - register: removed - retries: 10 - until: removed is not failed - ignore_errors: true - - name: remove testing security group ec2_group: state: absent diff --git a/tests/integration/targets/iam_server_certificate/aliases b/tests/integration/targets/iam_server_certificate/aliases deleted file mode 100644 index 98e604ec4b3..00000000000 --- a/tests/integration/targets/iam_server_certificate/aliases +++ /dev/null @@ -1,3 +0,0 @@ -cloud/aws - -iam_server_certificate_info diff --git a/tests/integration/targets/iam_server_certificate/defaults/main.yml b/tests/integration/targets/iam_server_certificate/defaults/main.yml deleted file mode 100644 index ed97d539c09..00000000000 --- a/tests/integration/targets/iam_server_certificate/defaults/main.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/tests/integration/targets/iam_server_certificate/meta/main.yml b/tests/integration/targets/iam_server_certificate/meta/main.yml deleted file mode 100644 index cb6005d042c..00000000000 --- a/tests/integration/targets/iam_server_certificate/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_remote_tmp_dir diff --git a/tests/integration/targets/iam_server_certificate/tasks/main.yml b/tests/integration/targets/iam_server_certificate/tasks/main.yml deleted file mode 100644 index f0c6946728a..00000000000 --- a/tests/integration/targets/iam_server_certificate/tasks/main.yml +++ /dev/null @@ -1,34 +0,0 @@ ---- -# iam_server_certificate integration tests -# -# Current module limitations: -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - # Check that the alias works - - iam_cert: {} - ignore_errors: true - register: iam_cert_alias - - - iam_server_certificate: {} - ignore_errors: true - register: no_args - - - assert: - that: - - iam_cert_alias is failed - - no_args is failed - - no_args.msg == iam_cert_alias.msg - - no_args.msg.startswith('missing required arguments') - - always: - - debug: msg=test - - ################################################ - # TEARDOWN STARTS HERE - ################################################ diff --git a/tests/integration/targets/redshift_subnet_group/aliases b/tests/integration/targets/redshift_subnet_group/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/redshift_subnet_group/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/redshift_subnet_group/defaults/main.yml b/tests/integration/targets/redshift_subnet_group/defaults/main.yml deleted file mode 100644 index ea8921880a9..00000000000 --- a/tests/integration/targets/redshift_subnet_group/defaults/main.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- -availability_zone: '{{ ec2_availability_zone_names[0] }}' - -vpc_name: '{{ resource_prefix }}' -subnet_name_a: '{{ resource_prefix }}-a' -subnet_name_b: '{{ resource_prefix }}-b' -subnet_name_c: '{{ resource_prefix }}-c' -subnet_name_d: '{{ resource_prefix }}-d' - -vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' -subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' -subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' -subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' -subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' - -subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' -subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' - -group_name: '{{ resource_prefix }}' -description_default: 'Subnet Description' -description_updated: 'updated subnet description' - -# Tagging not currently supported, planned with boto3 upgrade -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/redshift_subnet_group/meta/main.yml b/tests/integration/targets/redshift_subnet_group/meta/main.yml deleted file mode 100644 index 930e8622824..00000000000 --- a/tests/integration/targets/redshift_subnet_group/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_ec2_facts diff --git a/tests/integration/targets/redshift_subnet_group/tasks/main.yml b/tests/integration/targets/redshift_subnet_group/tasks/main.yml deleted file mode 100644 index e15ee9b9313..00000000000 --- a/tests/integration/targets/redshift_subnet_group/tasks/main.yml +++ /dev/null @@ -1,692 +0,0 @@ ---- -# redshift_subnet_group integration tests -# -# Current module limitations: -# - check_mode not supported -# - Tagging not supported -# - Module is not idempotent -# - Returned values *very* limited -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================================ - - - name: Create Subnet Group with no subnets - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - check_mode: True - - - name: Check result - Create Subnet Group with no subnets - check_mode - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateClusterSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"subnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - - name: Create Subnet Group with no subnets - redshift_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateClusterSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"subnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - # ============================================================ - # Setup infra needed for tests - - name: create a VPC - ec2_vpc_net: - state: present - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - tags: - TestPrefix: '{{ resource_prefix }}' - register: vpc_result - - - name: create subnets - ec2_vpc_subnet: - state: present - cidr: '{{ item.cidr }}' - az: '{{ item.zone }}' - vpc_id: '{{ vpc_result.vpc.id }}' - tags: - Name: '{{ item.name }}' - TestPrefix: '{{ resource_prefix }}' - register: vpc_subnet_create - loop: - - name: '{{ subnet_name_a }}' - cidr: '{{ subnet_cidr_a }}' - zone: '{{ subnet_zone_a }}' - - name: '{{ subnet_name_b }}' - cidr: '{{ subnet_cidr_b }}' - zone: '{{ subnet_zone_b }}' - - name: '{{ subnet_name_c }}' - cidr: '{{ subnet_cidr_c }}' - zone: '{{ subnet_zone_c }}' - - name: '{{ subnet_name_d }}' - cidr: '{{ subnet_cidr_d }}' - zone: '{{ subnet_zone_d }}' - - - name: Store IDs of subnets and VPC - set_fact: - vpc_id: '{{ vpc_result.vpc.id }}' - subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' - subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' - subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' - subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' - - # ============================================================ - - - name: Create Subnet Group - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - check_mode: True - - - name: Check result - Create Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create Subnet Group - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == description_default - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - - name: Create Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - check_mode: True - - - name: Check result - Create Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create Subnet Group - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == description_default - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Update Subnet Group Description - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - check_mode: True - - - name: Check result - Update Subnet Group Description - check_mode - assert: - that: - - update_description is successful - - update_description is changed - - - name: Update Subnet Group Description - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - assert: - that: - - update_description is successful - - update_description is changed - - '"group" in update_description' - - '"name" in update_description.group' - - '"vpc_id" in update_description.group' - - update_description.group.name == group_name - - update_description.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_description' - - '"description" in update_description.cluster_subnet_group' - - '"subnet_ids" in update_description.cluster_subnet_group' - - '"vpc_id" in update_description.cluster_subnet_group' - - update_description.cluster_subnet_group.name == group_name - - update_description.cluster_subnet_group.description == description_updated - - subnet_id_a in update_description.cluster_subnet_group.subnet_ids - - subnet_id_b in update_description.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids - - update_description.cluster_subnet_group.vpc_id == vpc_id - - - name: Update Subnet Group Description - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - check_mode: True - - - name: Check result - Update Subnet Group Description - idempotency - check_mode - assert: - that: - - update_description is successful - - update_description is not changed - - - name: Update Subnet Group Description - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - assert: - that: - - update_description is successful - - update_description is not changed - - '"group" in update_description' - - '"name" in update_description.group' - - '"vpc_id" in update_description.group' - - update_description.group.name == group_name - - update_description.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_description' - - '"description" in update_description.cluster_subnet_group' - - '"subnet_ids" in update_description.cluster_subnet_group' - - '"vpc_id" in update_description.cluster_subnet_group' - - update_description.cluster_subnet_group.name == group_name - - update_description.cluster_subnet_group.description == description_updated - - subnet_id_a in update_description.cluster_subnet_group.subnet_ids - - subnet_id_b in update_description.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids - - update_description.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Update Subnet Group subnets - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - check_mode: True - - - name: Check result - Update Subnet Group subnets - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is changed - - - name: Update Subnet Group subnets - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - assert: - that: - - update_subnets is successful - - update_subnets is changed - - '"group" in update_subnets' - - '"name" in update_subnets.group' - - '"vpc_id" in update_subnets.group' - - update_subnets.group.name == group_name - - update_subnets.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_subnets' - - '"description" in update_subnets.cluster_subnet_group' - - '"subnet_ids" in update_subnets.cluster_subnet_group' - - '"vpc_id" in update_subnets.cluster_subnet_group' - - update_subnets.cluster_subnet_group.name == group_name - - update_subnets.cluster_subnet_group.description == description_updated - - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids - - update_subnets.cluster_subnet_group.vpc_id == vpc_id - - - name: Update Subnet Group subnets - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - check_mode: True - - - name: Check result - Update Subnet Group subnets - idempotency - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - - name: Update Subnet Group subnets - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - '"group" in update_subnets' - - '"name" in update_subnets.group' - - '"vpc_id" in update_subnets.group' - - update_subnets.group.name == group_name - - update_subnets.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_subnets' - - '"description" in update_subnets.cluster_subnet_group' - - '"subnet_ids" in update_subnets.cluster_subnet_group' - - '"vpc_id" in update_subnets.cluster_subnet_group' - - update_subnets.cluster_subnet_group.name == group_name - - update_subnets.cluster_subnet_group.description == description_updated - - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids - - update_subnets.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Delete Subnet Group - check_mode - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - check_mode: True - - - name: Check result - Delete Subnet Group - check_mode - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - check_mode: True - - - name: Check result - Delete Subnet Group - idempotency - check_mode - assert: - that: - - delete_group is not changed - - - name: Delete Subnet Group - idempotency - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - assert: - that: - - delete_group is not changed - - # ============================================================ - - - name: Create minimal Subnet Group - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - check_mode: True - - - name: Check result - Create minimal Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create minimal Subnet Group - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == group_name - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - - name: Create minimal Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - check_mode: True - - - name: Check result - Create minimal Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create minimal Subnet Group - idempotency - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == group_name - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Full Update Subnet Group - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - check_mode: True - - - name: Check result - Full Update Subnet Group - check_mode - assert: - that: - - update_complex is successful - - update_complex is changed - - - name: Full Update Subnet Group - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - assert: - that: - - update_complex is successful - - update_complex is changed - - '"group" in update_complex' - - '"name" in update_complex.group' - - '"vpc_id" in update_complex.group' - - update_complex.group.name == group_name - - update_complex.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_complex' - - '"description" in update_complex.cluster_subnet_group' - - '"subnet_ids" in update_complex.cluster_subnet_group' - - '"vpc_id" in update_complex.cluster_subnet_group' - - update_complex.cluster_subnet_group.name == group_name - - update_complex.cluster_subnet_group.description == description_updated - - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids - - update_complex.cluster_subnet_group.vpc_id == vpc_id - - - name: Full Update Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - check_mode: True - - - name: Check result - Full Update Subnet Group - idempotency - check_mode - assert: - that: - - update_complex is successful - - update_complex is not changed - - - name: Full Update Subnet Group - idempotency - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - assert: - that: - - update_complex is successful - - update_complex is not changed - - '"group" in update_complex' - - '"name" in update_complex.group' - - '"vpc_id" in update_complex.group' - - update_complex.group.name == group_name - - update_complex.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_complex' - - '"description" in update_complex.cluster_subnet_group' - - '"subnet_ids" in update_complex.cluster_subnet_group' - - '"vpc_id" in update_complex.cluster_subnet_group' - - update_complex.cluster_subnet_group.name == group_name - - update_complex.cluster_subnet_group.description == description_updated - - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids - - update_complex.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - ignore_errors: True - - - name: tidy up subnet - ec2_vpc_subnet: - state: absent - cidr: '{{ item }}' - vpc_id: '{{ vpc_result.vpc.id }}' - loop: - - '{{ subnet_cidr_a }}' - - '{{ subnet_cidr_b }}' - - '{{ subnet_cidr_c }}' - - '{{ subnet_cidr_d }}' - ignore_errors: True - - - name: tidy up VPC - ec2_vpc_net: - state: absent - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - ignore_errors: True diff --git a/tests/integration/targets/route53/tasks/main.yml b/tests/integration/targets/route53/tasks/main.yml index ae80586dbe8..18f10ae2987 100644 --- a/tests/integration/targets/route53/tasks/main.yml +++ b/tests/integration/targets/route53/tasks/main.yml @@ -503,42 +503,6 @@ - alias_record is not failed - alias_record is not changed - - name: 'Create a weighted record' - route53: - state: present - zone: '{{ zone_one }}' - record: 'weighted.{{ zone_one }}' - type: CNAME - value: 'zid_test.{{ zone_one }}' - overwrite: True - identifier: "host1@www" - weight: 100 - region: '{{ omit }}' - register: weighted_record - - name: 'This should be changed' - assert: - that: - - weighted_record is not failed - - weighted_record is changed - - - name: 'Re-Create a weighted record' - route53: - state: present - zone: '{{ zone_one }}' - record: 'weighted.{{ zone_one }}' - type: CNAME - value: 'zid_test.{{ zone_one }}' - overwrite: True - identifier: "host1@www" - weight: 100 - region: '{{ omit }}' - register: weighted_record - - name: 'This should not be changed' - assert: - that: - - weighted_record is not failed - - weighted_record is not changed - always: - route53_info: query: record_sets @@ -557,20 +521,6 @@ loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' - - name: 'Loop over A/AAAA/CNAME records and delete them' - route53: - state: absent - zone: '{{ zone_one }}' - record: '{{ item.Name }}' - type: '{{ item.Type }}' - value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' - identifier: '{{ item.SetIdentifier }}' - region: '{{ omit }}' - ignore_errors: True - loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' - when: - - '"ResourceRecords" in item' - - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent @@ -601,21 +551,6 @@ loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' - - name: 'Loop over A/AAAA/CNAME records and delete them' - route53: - state: absent - zone: '{{ zone_two }}' - record: '{{ item.Name }}' - type: '{{ item.Type }}' - value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' - identifier: '{{ item.SetIdentifier }}' - region: '{{ omit }}' - private_zone: true - ignore_errors: True - loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' - when: - - '"ResourceRecords" in item' - - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent diff --git a/tests/integration/targets/setup_botocore_pip/defaults/main.yml b/tests/integration/targets/setup_botocore_pip/defaults/main.yml deleted file mode 100644 index 5a50b775907..00000000000 --- a/tests/integration/targets/setup_botocore_pip/defaults/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -default_botocore_version: '1.18.0' -default_boto3_version: '1.15.0' diff --git a/tests/integration/targets/setup_botocore_pip/handlers/main.yml b/tests/integration/targets/setup_botocore_pip/handlers/main.yml deleted file mode 100644 index 2536d1ac773..00000000000 --- a/tests/integration/targets/setup_botocore_pip/handlers/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: 'Delete temporary pip environment' - include_tasks: cleanup.yml diff --git a/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml b/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml deleted file mode 100644 index 25b3ec27efc..00000000000 --- a/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml +++ /dev/null @@ -1,5 +0,0 @@ -- name: 'Delete temporary pip environment' - file: - path: "{{ botocore_pip_directory }}" - state: absent - no_log: yes diff --git a/tests/integration/targets/setup_botocore_pip/tasks/main.yml b/tests/integration/targets/setup_botocore_pip/tasks/main.yml deleted file mode 100644 index b183b7d726d..00000000000 --- a/tests/integration/targets/setup_botocore_pip/tasks/main.yml +++ /dev/null @@ -1,42 +0,0 @@ -- name: 'Ensure that we have virtualenv available to us' - pip: - name: virtualenv - -- name: 'Create temporary directory for pip environment' - tempfile: - state: directory - prefix: botocore - suffix: .test - register: botocore_pip_directory - notify: - - 'Delete temporary pip environment' - -- name: 'Record temporary directory' - set_fact: - botocore_pip_directory: "{{ botocore_pip_directory.path }}" - -- set_fact: - botocore_virtualenv: "{{ botocore_pip_directory }}/virtualenv" - botocore_virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" - -- set_fact: - botocore_virtualenv_interpreter: "{{ botocore_virtualenv }}/bin/python" - -- pip: - name: - - 'boto3{{ _boto3_comparison }}{{ _boto3_version }}' - - 'botocore{{ _botocore_comparison }}{{ _botocore_version }}' - - 'coverage<5' - virtualenv: "{{ botocore_virtualenv }}" - virtualenv_command: "{{ botocore_virtualenv_command }}" - virtualenv_site_packages: no - vars: - _boto3_version: '{{ boto3_version | default(default_boto3_version) }}' - _botocore_version: '{{ botocore_version | default(default_botocore_version) }}' - _is_default_boto3: '{{ _boto3_version == default_boto3_version }}' - _is_default_botocore: '{{ _botocore_version == default_botocore_version }}' - # Only set the default to >= if the other dep has been updated and the dep has not been set - _default_boto3_comparison: '{% if _is_default_boto3 and not _is_default_botocore %}>={% else %}=={% endif %}' - _default_botocore_comparison: '{% if _is_default_botocore and not _is_default_boto3 %}>={% else %}=={% endif %}' - _boto3_comparison: '{{ boto3_comparison | default(_default_boto3_comparison) }}' - _botocore_comparison: '{{ botocore_comparison | default(_default_botocore_comparison) }}' diff --git a/tests/integration/targets/setup_ec2_facts/defaults/main.yml b/tests/integration/targets/setup_ec2_facts/defaults/main.yml deleted file mode 100644 index a09e9a53707..00000000000 --- a/tests/integration/targets/setup_ec2_facts/defaults/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -ec2_ami_name: 'Fedora-Cloud-Base-*.x86_64*' -ec2_ami_owner_id: '125523088429' -ec2_ami_ssh_user: 'fedora' diff --git a/tests/integration/targets/setup_ec2_facts/tasks/main.yml b/tests/integration/targets/setup_ec2_facts/tasks/main.yml deleted file mode 100644 index f41791073a3..00000000000 --- a/tests/integration/targets/setup_ec2_facts/tasks/main.yml +++ /dev/null @@ -1,53 +0,0 @@ ---- -# Setup a couple of common facts about the AWS Region -# -# Information about availablity zones -# - ec2_availability_zone_names -# -# An EC2 AMI that can be used for spinning up Instances performs as search -# rather than hardcoding the IDs so we're not limited to specific Regions -# - ec2_ami_id -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - - run_once: True - block: - # ============================================================ - - - name: Get available AZs - aws_az_info: - filters: - region-name: '{{ aws_region }}' - register: _az_info - - - name: Pick an AZ - set_fact: - ec2_availability_zone_names: '{{ _az_info.availability_zones | selectattr("zone_name", "defined") | map(attribute="zone_name") | list }}' - - # ============================================================ - - - name: Get a list of images - ec2_ami_info: - filters: - name: '{{ ec2_ami_name }}' - owner-id: '{{ ec2_ami_owner_id }}' - architecture: x86_64 - virtualization-type: hvm - root-device-type: ebs - register: _images_info - # Very spammy - no_log: True - - - name: Set Fact for latest AMI - vars: - latest_image: '{{ _images_info.images | sort(attribute="creation_date") | reverse | first }}' - set_fact: - ec2_ami_id: '{{ latest_image.image_id }}' - ec2_ami_details: '{{ latest_image }}' - ec2_ami_root_disk: '{{ latest_image.block_device_mappings[0].device_name }}' - ec2_ami_ssh_user: '{{ ec2_ami_ssh_user }}' diff --git a/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py b/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py deleted file mode 100644 index ea2f51b0f4c..00000000000 --- a/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py +++ /dev/null @@ -1,33 +0,0 @@ -#!/usr/bin/env python -""" -Reads an OpenSSH Public key and spits out the 'AWS' MD5 sum -The equivalent of - -ssh-keygen -f id_rsa.pub -e -m PKCS8 | openssl pkey -pubin -outform DER | openssl md5 -c | cut -f 2 -d ' ' - -(but without needing the OpenSSL CLI) -""" - -from __future__ import absolute_import, division, print_function -__metaclass__ = type - -import hashlib -import sys -from Crypto.PublicKey import RSA - -if len(sys.argv) == 0: - ssh_public_key = "id_rsa.pub" -else: - ssh_public_key = sys.argv[1] - -with open(ssh_public_key, 'r') as key_fh: - data = key_fh.read() - -# Convert from SSH format to DER format -public_key = RSA.importKey(data).exportKey('DER') -md5digest = hashlib.md5(public_key).hexdigest() -# Format the md5sum into the normal format -pairs = zip(md5digest[::2], md5digest[1::2]) -md5string = ":".join(["".join(pair) for pair in pairs]) - -print(md5string) diff --git a/tests/integration/targets/setup_sshkey/tasks/main.yml b/tests/integration/targets/setup_sshkey/tasks/main.yml deleted file mode 100644 index 31bd2176e5c..00000000000 --- a/tests/integration/targets/setup_sshkey/tasks/main.yml +++ /dev/null @@ -1,71 +0,0 @@ -# (c) 2014, James Laska - -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see . - -- name: create a temp dir - tempfile: - state: directory - register: sshkey_dir - tags: - - prepare - -- name: ensure script is available - copy: - src: ec2-fingerprint.py - dest: '{{ sshkey_dir.path }}/ec2-fingerprint.py' - mode: 0700 - tags: - - prepare - -- name: Set location of SSH keys - set_fact: - sshkey: '{{ sshkey_dir.path }}/key_one' - another_sshkey: '{{ sshkey_dir.path }}/key_two' - sshkey_pub: '{{ sshkey_dir.path }}/key_one.pub' - another_sshkey_pub: '{{ sshkey_dir.path }}/key_two.pub' - -- name: generate sshkey - shell: echo 'y' | ssh-keygen -P '' -f '{{ sshkey }}' - tags: - - prepare - -- name: record fingerprint - shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ sshkey_pub }}' - register: fingerprint - tags: - - prepare - -- name: generate another_sshkey - shell: echo 'y' | ssh-keygen -P '' -f {{ another_sshkey }} - tags: - - prepare - -- name: record another fingerprint - shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ another_sshkey_pub }}' - register: another_fingerprint - tags: - - prepare - -- name: set facts for future roles - set_fact: - # Public SSH keys (OpenSSH format) - key_material: "{{ lookup('file', sshkey_pub) }}" - another_key_material: "{{ lookup('file', another_sshkey_pub) }}" - # AWS 'fingerprint' (md5digest) - fingerprint: '{{ fingerprint.stdout }}' - another_fingerprint: '{{ another_fingerprint.stdout }}' - tags: - - prepare diff --git a/tests/integration/targets/sns_topic/tasks/main.yml b/tests/integration/targets/sns_topic/tasks/main.yml index 94214b20fa9..891b162e4d2 100644 --- a/tests/integration/targets/sns_topic/tasks/main.yml +++ b/tests/integration/targets/sns_topic/tasks/main.yml @@ -127,7 +127,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "20" + minDelayTarget: 20 maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -153,7 +153,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "20" + minDelayTarget: 20 maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -179,7 +179,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "40" + minDelayTarget: 40 maxDelayTarget: 40 numRetries: 6 numMaxDelayRetries: 0 diff --git a/tests/requirements.yml b/tests/requirements.yml index 3480da42122..27240dbf096 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 1.5.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 1.5.0 diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt deleted file mode 100644 index e5bade76474..00000000000 --- a/tests/sanity/ignore-2.13.txt +++ /dev/null @@ -1,3 +0,0 @@ -plugins/modules/cloudfront_info.py pylint:unnecessary-comprehension # (new test) Should be an easy fix, but testing is a challenge - test are broken and aliases require a wildcard cert in ACM -plugins/modules/iam.py pylint:unnecessary-comprehension # no tests and module is deprecated -plugins/modules/route53.py validate-modules:parameter-state-invalid-choice # route53_info needs improvements before we can deprecate this diff --git a/tests/unit/constraints.txt b/tests/unit/constraints.txt deleted file mode 100644 index bd95eb26733..00000000000 --- a/tests/unit/constraints.txt +++ /dev/null @@ -1,7 +0,0 @@ -# Specifically run tests against the oldest versions that we support -boto3==1.15.0 -botocore==1.18.0 - -# AWS CLI has `botocore==` dependencies, provide the one that matches botocore -# to avoid needing to download over a years worth of awscli wheels. -awscli==1.18.141 diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt index 704c73a25b2..4b10ff777a4 100644 --- a/tests/unit/requirements.txt +++ b/tests/unit/requirements.txt @@ -1,6 +1,3 @@ -# Our code is based on the AWS SDKs -botocore -boto3 -boto - placebo +botocore>=1.16.0 +boto3>=1.13.0 From 2e854d4567e477b3e9f63dc61cf77649bc869b3e Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 15 Sep 2021 17:08:16 +0100 Subject: [PATCH 16/29] Fix RDS bug --- plugins/modules/rds_instance.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/plugins/modules/rds_instance.py b/plugins/modules/rds_instance.py index c1f118db514..6fcacd37918 100644 --- a/plugins/modules/rds_instance.py +++ b/plugins/modules/rds_instance.py @@ -989,11 +989,10 @@ def get_changing_options_with_inconsistent_keys(modify_params, instance, purge_c def get_changing_options_with_consistent_keys(modify_params, instance): - inconsistent_parameters = list(modify_params.keys()) changing_params = {} for param in modify_params: - current_option = instance.get('PendingModifiedValues', {}).get(param) + current_option = instance.get('PendingModifiedValues', {}).get(param, None) if current_option is None: current_option = instance[param] if modify_params[param] != current_option: From f2906d8c619212b5cca14bf6c98d0ffaf3a45286 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 15 Sep 2021 17:15:50 +0100 Subject: [PATCH 17/29] add changelog --- changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml diff --git a/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml b/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml new file mode 100644 index 00000000000..2f7373c12e0 --- /dev/null +++ b/changelogs/fragments/712-rds-enhanced-monitoring-bug-fix.yml @@ -0,0 +1,2 @@ +bugfixes: +- rds_instance - Fixed issue with enabling enhanced monitoring on a pre-existing RDS instance (https://github.com/ansible-collections/community.aws/pull/712). From eecfccb00e1d4568a26fe1a0eface44922c91230 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 17 Sep 2021 11:23:22 +0100 Subject: [PATCH 18/29] add tests and make further bug fix tweak --- plugins/modules/rds_instance.py | 2 +- .../targets/rds_instance/inventory | 1 + .../roles/rds_instance/defaults/main.yml | 1 + .../enhanced_monitoring_assume_policy.json | 13 ++++ .../tasks/test_enhanced_monitoring.yml | 68 +++++++++++++++++++ 5 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json create mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml diff --git a/plugins/modules/rds_instance.py b/plugins/modules/rds_instance.py index 6fcacd37918..92d5e257cf0 100644 --- a/plugins/modules/rds_instance.py +++ b/plugins/modules/rds_instance.py @@ -994,7 +994,7 @@ def get_changing_options_with_consistent_keys(modify_params, instance): for param in modify_params: current_option = instance.get('PendingModifiedValues', {}).get(param, None) if current_option is None: - current_option = instance[param] + current_option = instance.get(param, None) if modify_params[param] != current_option: changing_params[param] = modify_params[param] diff --git a/tests/integration/targets/rds_instance/inventory b/tests/integration/targets/rds_instance/inventory index e19e0c76b3a..198a033504c 100644 --- a/tests/integration/targets/rds_instance/inventory +++ b/tests/integration/targets/rds_instance/inventory @@ -4,6 +4,7 @@ tags modification bad_options processor_features +enhanced_monitoring encryption final_snapshot read_replica diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml index 33760c64660..19654342a8b 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml @@ -8,6 +8,7 @@ storage_encrypted_db_instance_class: db.t3.small modified_db_instance_class: db.t3.medium allocated_storage: 20 modified_allocated_storage: 30 +monitoring_interval: 60 # For aurora tests cluster_id: "{{ resource_prefix }}-cluster" diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json b/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json new file mode 100644 index 00000000000..29acf369fc9 --- /dev/null +++ b/tests/integration/targets/rds_instance/roles/rds_instance/files/enhanced_monitoring_assume_policy.json @@ -0,0 +1,13 @@ +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "monitoring.rds.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] +} diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml new file mode 100644 index 00000000000..90a415cda76 --- /dev/null +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -0,0 +1,68 @@ +--- +- block: + - name: Ensure the resource doesn't exist + rds_instance: + id: "{{ instance_id }}" + state: absent + skip_final_snapshot: True + register: result + + - assert: + that: + - not result.changed + ignore_errors: yes + + - name: Create a mariadb instance without enhanced monitoring + rds_instance: + id: "{{ instance_id }}" + state: present + engine: mariadb + engine_version: "{{ mariadb_engine_version }}" + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + register: result + + - assert: + that: + - result.changed + - "result.db_instance_identifier == '{{ instance_id }}'" + + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + + - name: Modify the instance immediately to enable enhanced monitoring + rds_instance: + id: "{{ instance_id }}" + state: present + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring.arn }}" + apply_immediately: True + register: result + + - assert: + that: + - result.changed + - 'result.monitoring_interval == "{{ monitoring_interval }}"' + + always: + - name: Delete the instance + rds_instance: + id: "{{ item }}" + state: absent + skip_final_snapshot: True + loop: + - "{{ instance_id }}" + - "{{ modified_instance_id }}" + ignore_errors: yes + + - name: Delete the role + iam_role: + name: "{{ instance_id }}-role" + state: absent From cfa1a69a0066e84debab712a90ec6eeb909f6c5a Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 17 Sep 2021 11:30:53 +0100 Subject: [PATCH 19/29] test update --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 90a415cda76..96cde7eb94c 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -54,12 +54,9 @@ always: - name: Delete the instance rds_instance: - id: "{{ item }}" + id: "{{ instance_id }}" state: absent skip_final_snapshot: True - loop: - - "{{ instance_id }}" - - "{{ modified_instance_id }}" ignore_errors: yes - name: Delete the role From feeae5b64f1875d5e03d3a7c9b8fa802aac8398e Mon Sep 17 00:00:00 2001 From: Mark Woolley Date: Sat, 18 Sep 2021 12:28:46 +0100 Subject: [PATCH 20/29] correct test var --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 96cde7eb94c..fc7f1ed09eb 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -42,7 +42,7 @@ id: "{{ instance_id }}" state: present monitoring_interval: "{{ monitoring_interval }}" - monitoring_role_arn: "{{ enhanced_monitoring.arn }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" apply_immediately: True register: result From 3e38cef76335a398c67719c3fc7a7cf27aea03df Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 20 Sep 2021 18:00:39 +0100 Subject: [PATCH 21/29] Enable tests --- tests/integration/targets/rds_instance/aliases | 4 ---- 1 file changed, 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/aliases b/tests/integration/targets/rds_instance/aliases index 283523234b9..4ef4b2067d0 100644 --- a/tests/integration/targets/rds_instance/aliases +++ b/tests/integration/targets/rds_instance/aliases @@ -1,5 +1 @@ -# reason: missing-policy -# reason: slow -unsupported - cloud/aws From 4d7d794dc72da3435aab7c370997afffc1bedff3 Mon Sep 17 00:00:00 2001 From: Mark Woolley Date: Mon, 27 Sep 2021 11:52:23 +0100 Subject: [PATCH 22/29] Update tests/integration/targets/rds_instance/aliases Co-authored-by: Mark Chappell --- tests/integration/targets/rds_instance/aliases | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/integration/targets/rds_instance/aliases b/tests/integration/targets/rds_instance/aliases index 4ef4b2067d0..e30a1801b1e 100644 --- a/tests/integration/targets/rds_instance/aliases +++ b/tests/integration/targets/rds_instance/aliases @@ -1 +1,3 @@ +slow + cloud/aws From 7cbf05eb67d3b4fcab90010fad217adb9c32c2cb Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 27 Sep 2021 11:53:13 +0100 Subject: [PATCH 23/29] try leaving out the iam deletion for enhanced monitoring --- .../roles/rds_instance/tasks/test_enhanced_monitoring.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index fc7f1ed09eb..66893d4caeb 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -58,8 +58,3 @@ state: absent skip_final_snapshot: True ignore_errors: yes - - - name: Delete the role - iam_role: - name: "{{ instance_id }}-role" - state: absent From eb7ba05915631f88d4df0431097a2287a0982fc9 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Mon, 27 Sep 2021 12:45:07 +0100 Subject: [PATCH 24/29] move IAM creation to earlier on --- .../tasks/test_enhanced_monitoring.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml index 66893d4caeb..d1201a7f755 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml @@ -12,6 +12,14 @@ - not result.changed ignore_errors: yes + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + - name: Create a mariadb instance without enhanced monitoring rds_instance: id: "{{ instance_id }}" @@ -29,14 +37,6 @@ - result.changed - "result.db_instance_identifier == '{{ instance_id }}'" - - name: Create an enhanced monitoring role - iam_role: - assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" - name: "{{ instance_id }}-role" - state: present - managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" - register: enhanced_monitoring_role - - name: Modify the instance immediately to enable enhanced monitoring rds_instance: id: "{{ instance_id }}" From ebb27b7eba6ef76c2fa6a3f7146503964a824e4c Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Wed, 29 Sep 2021 12:35:21 +0100 Subject: [PATCH 25/29] The tests are exceeding a 1hr session limit - Condense tests where possible - Remove irrelevant snapshot tests - Up concurrency to 6 --- .../targets/rds_instance/inventory | 6 - .../integration/targets/rds_instance/main.yml | 2 +- .../rds_instance/tasks/test_bad_options.yml | 31 --- .../rds_instance/tasks/test_encryption.yml | 42 --- .../tasks/test_enhanced_monitoring.yml | 60 ----- .../tasks/test_final_snapshot.yml | 61 ----- .../rds_instance/tasks/test_modification.yml | 17 ++ .../rds_instance/tasks/test_snapshot.yml | 83 ------ .../roles/rds_instance/tasks/test_states.yml | 154 +++++++---- .../roles/rds_instance/tasks/test_tags.yml | 241 ------------------ 10 files changed, 116 insertions(+), 581 deletions(-) delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml delete mode 100644 tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml diff --git a/tests/integration/targets/rds_instance/inventory b/tests/integration/targets/rds_instance/inventory index 198a033504c..47b2a44a6ab 100644 --- a/tests/integration/targets/rds_instance/inventory +++ b/tests/integration/targets/rds_instance/inventory @@ -1,16 +1,10 @@ [tests] states -tags modification -bad_options processor_features -enhanced_monitoring -encryption -final_snapshot read_replica vpc_security_groups restore_instance -snapshot # TODO: uncomment after adding rds_cluster module # aurora diff --git a/tests/integration/targets/rds_instance/main.yml b/tests/integration/targets/rds_instance/main.yml index fc2c909ec11..44695589af6 100644 --- a/tests/integration/targets/rds_instance/main.yml +++ b/tests/integration/targets/rds_instance/main.yml @@ -6,6 +6,6 @@ - hosts: all gather_facts: no strategy: free - serial: 5 + serial: 6 roles: - rds_instance diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml deleted file mode 100644 index 9fd2f4fa6e4..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_bad_options.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a DB instance with an invalid engine - rds_instance: - id: "{{ instance_id }}" - state: present - engine: thisisnotavalidengine - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - ignore_errors: True - - - assert: - that: - - result.failed - - '"DB engine thisisnotavalidengine should be one of" in result.msg' diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml deleted file mode 100644 index 6c3e81494e5..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_encryption.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ storage_encrypted_db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - storage_encrypted: True - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - result.kms_key_id - - result.storage_encrypted == true - - always: - - - name: Delete DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml deleted file mode 100644 index d1201a7f755..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_enhanced_monitoring.yml +++ /dev/null @@ -1,60 +0,0 @@ ---- -- block: - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create an enhanced monitoring role - iam_role: - assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" - name: "{{ instance_id }}-role" - state: present - managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" - register: enhanced_monitoring_role - - - name: Create a mariadb instance without enhanced monitoring - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - engine_version: "{{ mariadb_engine_version }}" - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - - name: Modify the instance immediately to enable enhanced monitoring - rds_instance: - id: "{{ instance_id }}" - state: present - monitoring_interval: "{{ monitoring_interval }}" - monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" - apply_immediately: True - register: result - - - assert: - that: - - result.changed - - 'result.monitoring_interval == "{{ monitoring_interval }}"' - - always: - - name: Delete the instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml deleted file mode 100644 index 922a008c353..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_final_snapshot.yml +++ /dev/null @@ -1,61 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - id: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - name: Delete the DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - final_snapshot_identifier: "{{ instance_id }}" - register: result - - - assert: - that: - - result.changed - - "result.final_snapshot.db_instance_identifier == '{{ instance_id }}'" - - - name: Check that snapshot exists - rds_snapshot_info: - db_snapshot_identifier: "{{ instance_id }}" - register: result - - - assert: - that: - - "result.snapshots | length == 1" - - "result.snapshots.0.engine == 'mariadb'" - - always: - - name: Remove the snapshot - rds_snapshot: - db_snapshot_identifier: "{{ instance_id }}" - state: absent - ignore_errors: yes - - - name: Remove the DB instance - rds_instance: - id: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index 03e49967cae..6aec1d4db77 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -14,6 +14,14 @@ - not result.changed ignore_errors: yes + - name: Create an enhanced monitoring role + iam_role: + assume_role_policy_document: "{{ lookup('file','files/enhanced_monitoring_assume_policy.json') }}" + name: "{{ instance_id }}-role" + state: present + managed_policy: "arn:aws:iam::aws:policy/service-role/AmazonRDSEnhancedMonitoringRole" + register: enhanced_monitoring_role + - name: Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -100,6 +108,8 @@ # TODO: test modifying db_subnet_group_name, db_security_groups, db_parameter_group_name, option_group_name, # monitoring_role_arn, monitoring_interval, domain, domain_iam_role_name, cloudwatch_logs_export_configuration + # Test multiple modifications including enabling enhanced monitoring + - name: Modify several attributes rds_instance: id: '{{ instance_id }}' @@ -112,6 +122,8 @@ engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 apply_immediately: True @@ -125,6 +137,7 @@ - '"port" in result.pending_modified_values or result.endpoint.port == 1150' - '"db_instance_class" in result.pending_modified_values or result.db_instance_class == modified_db_instance_class' - '"engine_version" in result.pending_modified_values or result.engine_version == mariadb_engine_version_2' + - '"monitoring_interval" in result.pending_modified_values or result.monitoring_interval == monitoring_interval' - name: Idempotence modifying several pending attributes rds_instance: @@ -138,6 +151,8 @@ engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 register: result @@ -166,6 +181,8 @@ engine_version: "10.2.21" allow_major_version_upgrade: true auto_minor_version_upgrade: false + monitoring_interval: "{{ monitoring_interval }}" + monitoring_role_arn: "{{ enhanced_monitoring_role.arn }}" port: 1150 max_allocated_storage: 100 register: result diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml deleted file mode 100644 index 131f9753e88..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_snapshot.yml +++ /dev/null @@ -1,83 +0,0 @@ ---- - - block: - - - name: Getting shared snapshots - rds_snapshot_info: - snapshot_type: "shared" - register: result - - - assert: - that: - - not result.changed - - result.cluster_snapshots is defined - - result.snapshots is defined - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: - Name: "{{ instance_id }}" - Created_by: Ansible rds_instance tests - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}'" - - "result.tags.Created_by == 'Ansible rds_instance tests'" - - - name: Getting public snapshots - rds_snapshot_info: - db_instance_identifier: "{{ instance_id }}" - snapshot_type: "public" - register: result - - - assert: - that: - - not result.changed - - result.cluster_snapshots is not defined - - result.snapshots is defined - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed - - # TODO ideally we test with an actual shared snapshot - but we'd need a second account - making tests fairly complicated? - - always: - - - name: Delete the instance - rds_instance: - id: "{{ item }}" - state: absent - skip_final_snapshot: True - loop: - - "{{ instance_id }}" - ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml index 7b16f81a183..0fff73e7ca3 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml @@ -13,6 +13,25 @@ - not result.changed ignore_errors: yes + # Test invalid bad options + - name: Create a DB instance with an invalid engine + rds_instance: + id: "{{ instance_id }}" + state: present + engine: thisisnotavalidengine + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + register: result + ignore_errors: True + + - assert: + that: + - result.failed + - '"DB engine thisisnotavalidengine should be one of" in result.msg' + + # Test clean instance creation with good options - name: Check Mode - Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -22,6 +41,10 @@ password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" allocated_storage: "{{ allocated_storage }}" + storage_encrypted: True + tags: + Name: "{{ instance_id }}" + Created_by: Ansible rds_instance tests register: result check_mode: yes @@ -29,6 +52,7 @@ that: - result.changed + # Test creation, adding tags and enabling encryption - name: Create a mariadb instance rds_instance: id: "{{ instance_id }}" @@ -38,14 +62,23 @@ password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" allocated_storage: "{{ allocated_storage }}" + storage_encrypted: True + tags: + Name: "{{ instance_id }}" + Created_by: Ansible rds_instance tests register: result - assert: that: - result.changed - "result.db_instance_identifier == '{{ instance_id }}'" + - "result.tags | length == 2" + - "result.tags.Name == '{{ instance_id }}'" + - "result.tags.Created_by == 'Ansible rds_instance tests'" + - result.kms_key_id + - result.storage_encrypted == true - - name: Idempotence + - name: Test impotency omitting tags rds_instance: id: '{{ instance_id }}' state: present @@ -60,6 +93,7 @@ that: - not result.changed - result.db_instance_identifier + - "result.tags | length == 2" - name: Idempotence with minimal options rds_instance: @@ -71,7 +105,60 @@ that: - not result.changed - result.db_instance_identifier + - "result.tags | length == 2" + + - name: Test tags are not purged if purge_tags is False + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + engine: mariadb + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + tags: {} + purge_tags: False + register: result + + - assert: + that: + - not result.changed + - "result.tags | length == 2" + + - name: Add a tag and remove a tag + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + tags: + Name: "{{ instance_id }}-new" + Created_by: Ansible rds_instance tests + purge_tags: True + register: result + + - assert: + that: + - result.changed + - "result.tags | length == 2" + - "result.tags.Name == '{{ instance_id }}-new'" + + - name: Remove all tags + rds_instance: + db_instance_identifier: "{{ instance_id }}" + state: present + engine: mariadb + username: "{{ username }}" + password: "{{ password }}" + db_instance_class: "{{ db_instance_class }}" + allocated_storage: "{{ allocated_storage }}" + tags: {} + register: result + + - assert: + that: + - result.changed + - not result.tags + # Test stopping / rebooting instances - name: Check Mode - stop the instance rds_instance: id: '{{ instance_id }}' @@ -161,73 +248,28 @@ that: - result.changed - - name: take a snapshot - rds_snapshot: - db_instance_identifier: '{{ instance_id }}' - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: present - wait: yes - - - name: take a snapshot - idempotence - rds_snapshot: - db_instance_identifier: '{{ instance_id }}' - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: present - register: result - - - assert: - that: - - not result.changed - - - name: check snapshot is ok - rds_snapshot_info: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - register: result - - - assert: - that: - - (result.snapshots | length) == 1 - - - name: remove a snapshot without wait - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' + # Test final snapshot on deletion + - name: Delete the DB instance + rds_instance: + id: "{{ instance_id }}" state: absent + final_snapshot_identifier: "{{ instance_id }}" register: result - assert: that: - result.changed + - "result.final_snapshot.db_instance_identifier == '{{ instance_id }}'" - - name: remove a snapshot without wait - idempotence - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: absent - wait: yes - register: result - - - assert: - that: - - not result.changed - - - name: remove a snapshot with wait - idempotence - rds_snapshot: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' - state: absent - wait: yes - register: result - - - assert: - that: - - not result.changed - - - name: check snapshot is removed + - name: Check that snapshot exists rds_snapshot_info: - db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' + db_snapshot_identifier: "{{ instance_id }}" register: result - assert: that: - - not result.snapshots + - "result.snapshots | length == 1" + - "result.snapshots.0.engine == 'mariadb'" always: diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml deleted file mode 100644 index 353daec1f31..00000000000 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_tags.yml +++ /dev/null @@ -1,241 +0,0 @@ ---- - - block: - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - not result.changed - ignore_errors: yes - - - name: Create a mariadb instance - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: - Name: "{{ instance_id }}" - Created_by: Ansible rds_instance tests - register: result - - - assert: - that: - - result.changed - - "result.db_instance_identifier == '{{ instance_id }}'" - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}'" - - "result.tags.Created_by == 'Ansible rds_instance tests'" - - - name: Test idempotence omitting tags - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - register: result - - - assert: - that: - - not result.changed - - "result.tags | length == 2" - - - name: Test tags are not purged if purge_tags is False - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: {} - purge_tags: False - register: result - - - assert: - that: - - not result.changed - - "result.tags | length == 2" - - - name: Add a tag and remove a tag - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - tags: - Name: "{{ instance_id }}-new" - Created_by: Ansible rds_instance tests - purge_tags: True - register: result - - - assert: - that: - - result.changed - - "result.tags | length == 2" - - "result.tags.Name == '{{ instance_id }}-new'" - - - name: Remove all tags - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: present - engine: mariadb - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: "{{ db_instance_class }}" - allocated_storage: "{{ allocated_storage }}" - tags: {} - register: result - - - assert: - that: - - result.changed - - not result.tags - - - name: snapshot instance without tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - wait: yes - register: result - - - assert: - that: - - result.changed - - not result.tags - - - name: add tags to snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - two: world - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - - name: add tags to snapshot - idempotence - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - two: world - register: result - - - assert: - that: - - not result.changed - - result.tags | length == 2 - - - name: add tag to snapshot using purge_tags False - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - purge_tags: False - register: result - - - assert: - that: - - result.changed - - result.tags | length == 3 - - - name: rerun tags but not setting purge_tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - - name: rerun tags but not setting purge_tags - idempotence - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - register: result - - - assert: - that: - - not result.changed - - result.tags | length == 2 - - - name: remove snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: absent - wait: yes - register: result - - - assert: - that: - - result.changed - - - name: create snapshot with tags - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: present - tags: - one: hello - three: another - purge_tags: yes - wait: yes - register: result - - - assert: - that: - - result.changed - - result.tags | length == 2 - - always: - - - name: tidy up snapshot - rds_snapshot: - db_instance_identifier: "{{ instance_id }}" - db_snapshot_identifier: "{{ resource_prefix }}-test-tags" - state: absent - ignore_errors: yes - - - name: Ensure the resource doesn't exist - rds_instance: - db_instance_identifier: "{{ instance_id }}" - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed From 1c21ac2765f67254b28763d21b956f1f2e3c5f8a Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 15:51:29 +0100 Subject: [PATCH 26/29] PR feedback --- .../rds_instance/roles/rds_instance/defaults/main.yml | 1 + .../roles/rds_instance/tasks/test_modification.yml | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml index 19654342a8b..2e09597d4ec 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/defaults/main.yml @@ -9,6 +9,7 @@ modified_db_instance_class: db.t3.medium allocated_storage: 20 modified_allocated_storage: 30 monitoring_interval: 60 +preferred_maintenance_window: "mon:06:20-mon:06:50" # For aurora tests cluster_id: "{{ resource_prefix }}-cluster" diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index 6aec1d4db77..ac76d9d999d 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -28,6 +28,7 @@ state: present engine: mariadb engine_version: "{{ mariadb_engine_version }}" + allow_major_version_upgrade: true username: "{{ username }}" password: "{{ password }}" db_instance_class: "{{ db_instance_class }}" @@ -118,7 +119,7 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "mon:06:20-mon:06:50" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false @@ -147,7 +148,7 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "mon:06:20-mon:06:50" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false @@ -177,8 +178,8 @@ db_instance_class: "{{ modified_db_instance_class }}" backup_retention_period: 2 preferred_backup_window: "05:00-06:00" - preferred_maintenance_window: "Mon:06:20-Mon:06:50" - engine_version: "10.2.21" + preferred_maintenance_window: "{{ preferred_maintenance_window }}" + engine_version: "{{ mariadb_engine_version_2 }}" allow_major_version_upgrade: true auto_minor_version_upgrade: false monitoring_interval: "{{ monitoring_interval }}" From 4c222aaefba5e18f7f8b425f54da3fbaba4f163f Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 15:56:46 +0100 Subject: [PATCH 27/29] disable wait on final delete --- .../rds_instance/roles/rds_instance/tasks/test_aurora.yml | 2 ++ .../roles/rds_instance/tasks/test_modification.yml | 1 + .../roles/rds_instance/tasks/test_processor_features.yml | 1 + .../roles/rds_instance/tasks/test_read_replica.yml | 2 ++ .../roles/rds_instance/tasks/test_restore_instance.yml | 2 ++ .../rds_instance/roles/rds_instance/tasks/test_states.yml | 3 ++- .../roles/rds_instance/tasks/test_vpc_security_groups.yml | 4 ++++ 7 files changed, 14 insertions(+), 1 deletion(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml index c3a880d6bb1..031d0b8464e 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_aurora.yml @@ -113,6 +113,7 @@ id: "{{ item }}" state: absent skip_final_snapshot: True + wait: false loop: - "{{ instance_id }}" - "{{ modified_instance_id }}" @@ -123,4 +124,5 @@ cluster_id: "{{ cluster_id }}" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index ac76d9d999d..b2aa881cc43 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -219,5 +219,6 @@ id: '{{ item }}' state: absent skip_final_snapshot: True + wait: false loop: ['{{ instance_id }}', '{{ modified_instance_id }}'] ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml index 78dd44be4f0..a969f51debe 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_processor_features.yml @@ -104,6 +104,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result - assert: diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml index 4aee2687d31..7ca19747dde 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_read_replica.yml @@ -137,6 +137,7 @@ state: absent skip_final_snapshot: True region: "{{ region_src }}" + wait: false ignore_errors: yes - name: Remove the DB replica @@ -145,4 +146,5 @@ state: absent skip_final_snapshot: True region: "{{ region_dest }}" + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml index 64a948211c3..e8355299111 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml @@ -70,6 +70,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes @@ -78,4 +79,5 @@ id: "{{ instance_id }}-point-in-time" state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml index 0fff73e7ca3..b3c06245315 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml @@ -277,7 +277,7 @@ rds_snapshot: db_snapshot_identifier: '{{ resource_prefix }}-test-snapshot' state: absent - wait: yes + wait: false ignore_errors: yes - name: Remove DB instance @@ -285,4 +285,5 @@ id: '{{ instance_id }}' state: absent skip_final_snapshot: True + wait: false ignore_errors: yes diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml index 940ce5b0fae..917b8c430af 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_vpc_security_groups.yml @@ -145,6 +145,7 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result ignore_errors: yes @@ -153,6 +154,7 @@ name: "{{ item }}" description: "created by rds_instance integration tests" state: absent + wait: false register: sgs_result loop: - "{{ resource_prefix }}-sg-1" @@ -168,6 +170,7 @@ Name: "{{ resource_prefix }}-subnet" Description: "created by rds_instance integration tests" state: absent + wait: false register: subnets ignore_errors: yes retries: 30 @@ -198,5 +201,6 @@ id: "{{ instance_id }}" state: absent skip_final_snapshot: True + wait: false register: result ignore_errors: yes From 5f4a204fb2bd603b61a52479e7f2827ca5290e21 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 1 Oct 2021 16:05:41 +0100 Subject: [PATCH 28/29] further adjust --- .../roles/rds_instance/tasks/test_modification.yml | 12 ------------ .../rds_instance/tasks/test_restore_instance.yml | 1 - 2 files changed, 13 deletions(-) diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml index b2aa881cc43..e162509d549 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_modification.yml @@ -200,18 +200,6 @@ - '"db_instance_class" in result.pending_modified_values or result.db_instance_class == "db.t2.medium"' - '"engine_version" in result.pending_modified_values or result.engine_version == "10.2.21"' - - name: Delete the instance - rds_instance: - id: '{{ instance_id }}' - state: absent - skip_final_snapshot: True - register: result - - - assert: - that: - - result.changed - - '"pending_modified_values" not in result' - always: - name: Delete the instance diff --git a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml index e8355299111..7816cbcce11 100644 --- a/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml +++ b/tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_restore_instance.yml @@ -73,7 +73,6 @@ wait: false ignore_errors: yes - - name: Remove the point in time restored DB rds_instance: id: "{{ instance_id }}-point-in-time" From 54cf169e483b5e6e6e033a13477eeff1d13f5af3 Mon Sep 17 00:00:00 2001 From: mark-woolley Date: Fri, 8 Oct 2021 09:34:08 +0100 Subject: [PATCH 29/29] Revert "Squashed commit of the following:" This reverts commit 8d9aacc5c9655dea2483c08dc37948486fe94cbe. --- CHANGELOG.rst | 120 -- README.md | 16 +- bindep.txt | 4 - changelogs/changelog.yaml | 219 ---- changelogs/fragments/0-copy_ignore_txt.yml | 3 - ...-elb-module-add-ip_address_type_option.yml | 4 + ..._instance-preferred_maintenance_window.yml | 2 + changelogs/fragments/564-route53-retries.yml | 6 + .../574-ecs_taskdefinition-improvement.yml | 3 + changelogs/fragments/586-elb-renames.yml | 8 + .../fragments/592-sqs_queue-idempotent.yml | 2 + .../fragments/595-fix-route53-identifer.yaml | 2 - ...s-task-defination-env-file-validations.yml | 2 + .../fragments/614-ec2_vpc_peer-tagging.yml | 4 + .../616-ec2_vpc_route_table-tagging.yml | 4 + changelogs/fragments/629-imports-cleanup.yml | 2 + changelogs/fragments/648-kms_info.yml | 4 + changelogs/fragments/659-checkmode.yml | 10 + changelogs/fragments/663-deprecate-rds.yml | 3 + changelogs/fragments/664-deprecate-iam.yml | 3 + .../670-elb_target_group-new_attriibutes.yml | 3 - changelogs/fragments/675-boto3-minimums.yml | 26 + .../681-aws_secret-deletion-idempotency.yml | 2 + .../682-aws_s3_bucket_info-botocore.yml | 2 + changelogs/fragments/686-pylint.yml | 4 + changelogs/fragments/688-pylint.yml | 10 + .../692-s3_sync-individual-file-path.yml | 2 + ...-UpdateRoleDescription-with-UpdateRole.yml | 2 + ...d-cloudfront-new-security-policy-2021.yaml | 2 - .../724-redshift_subnet_group-boto3.yml | 7 - changelogs/fragments/728-iam_cert.yml | 3 - .../fragments/731-ec2_eip-not_in_vpc.yml | 2 - .../735-iam_server_certificate-file-names.yml | 3 - .../739-sns_topic-delivery_policy-shape.yml | 2 - .../fragments/deprecate_ec2_inv_script.yml | 2 + changelogs/fragments/migrate_ec2_instance.yml | 3 + .../fragments/migrate_ec2_vpc_endpoint.yml | 13 + changelogs/fragments/migrate_ec2_vpc_igw.yml | 10 + .../fragments/migrate_ec2_vpc_nat_gateway.yml | 10 + .../fragments/rename-connection-retries.yml | 2 + changelogs/fragments/sns_topic_type.yml | 2 + docs/community.aws.aws_acm_info_module.rst | 24 +- docs/community.aws.aws_acm_module.rst | 24 +- docs/community.aws.aws_api_gateway_module.rst | 24 +- ....aws_application_scaling_policy_module.rst | 26 +- ...s.aws_batch_compute_environment_module.rst | 24 +- ...ty.aws.aws_batch_job_definition_module.rst | 24 +- ...mmunity.aws.aws_batch_job_queue_module.rst | 24 +- docs/community.aws.aws_codebuild_module.rst | 25 +- docs/community.aws.aws_codecommit_module.rst | 25 +- .../community.aws.aws_codepipeline_module.rst | 25 +- ...onfig_aggregation_authorization_module.rst | 25 +- ...unity.aws.aws_config_aggregator_module.rst | 25 +- ...aws.aws_config_delivery_channel_module.rst | 25 +- ...mmunity.aws.aws_config_recorder_module.rst | 25 +- docs/community.aws.aws_config_rule_module.rst | 25 +- ...rect_connect_confirm_connection_module.rst | 25 +- ...s.aws_direct_connect_connection_module.rst | 25 +- ....aws.aws_direct_connect_gateway_module.rst | 24 +- ..._connect_link_aggregation_group_module.rst | 25 +- ...irect_connect_virtual_interface_module.rst | 25 +- docs/community.aws.aws_eks_cluster_module.rst | 25 +- ...ty.aws.aws_elasticbeanstalk_app_module.rst | 23 +- ...mmunity.aws.aws_glue_connection_module.rst | 24 +- docs/community.aws.aws_glue_job_module.rst | 24 +- ...munity.aws.aws_inspector_target_module.rst | 25 +- docs/community.aws.aws_kms_info_module.rst | 47 +- docs/community.aws.aws_kms_module.rst | 23 +- docs/community.aws.aws_msk_cluster_module.rst | 1031 ----------------- docs/community.aws.aws_msk_config_module.rst | 435 ------- docs/community.aws.aws_region_info_module.rst | 25 +- ...ommunity.aws.aws_s3_bucket_info_module.rst | 25 +- docs/community.aws.aws_s3_cors_module.rst | 23 +- docs/community.aws.aws_secret_module.rst | 25 +- .../community.aws.aws_ses_identity_module.rst | 25 +- ...ity.aws.aws_ses_identity_policy_module.rst | 25 +- .../community.aws.aws_ses_rule_set_module.rst | 25 +- docs/community.aws.aws_sgw_info_module.rst | 24 +- docs/community.aws.aws_ssm_connection.rst | 20 +- ...ity.aws.aws_ssm_parameter_store_module.rst | 25 +- ...nctions_state_machine_execution_module.rst | 23 +- ...ws_step_functions_state_machine_module.rst | 23 +- ...community.aws.aws_waf_condition_module.rst | 23 +- docs/community.aws.aws_waf_info_module.rst | 24 +- docs/community.aws.aws_waf_rule_module.rst | 23 +- docs/community.aws.aws_waf_web_acl_module.rst | 23 +- ...aws.cloudformation_exports_info_module.rst | 24 +- ...ty.aws.cloudformation_stack_set_module.rst | 25 +- ...ity.aws.cloudfront_distribution_module.rst | 98 +- docs/community.aws.cloudfront_info_module.rst | 24 +- ...ity.aws.cloudfront_invalidation_module.rst | 24 +- ...oudfront_origin_access_identity_module.rst | 24 +- docs/community.aws.cloudtrail_module.rst | 25 +- ...munity.aws.cloudwatchevent_rule_module.rst | 24 +- ...s.cloudwatchlogs_log_group_info_module.rst | 25 +- ...tchlogs_log_group_metric_filter_module.rst | 25 +- ...ty.aws.cloudwatchlogs_log_group_module.rst | 26 +- docs/community.aws.data_pipeline_module.rst | 24 +- docs/community.aws.dms_endpoint_module.rst | 23 +- ...ws.dms_replication_subnet_group_module.rst | 23 +- docs/community.aws.dynamodb_table_module.rst | 26 +- docs/community.aws.dynamodb_ttl_module.rst | 28 +- docs/community.aws.ec2_ami_copy_module.rst | 24 +- docs/community.aws.ec2_asg_info_module.rst | 24 +- ...nity.aws.ec2_asg_lifecycle_hook_module.rst | 24 +- docs/community.aws.ec2_asg_module.rst | 25 +- ...y.aws.ec2_customer_gateway_info_module.rst | 24 +- ...munity.aws.ec2_customer_gateway_module.rst | 25 +- docs/community.aws.ec2_eip_info_module.rst | 23 +- docs/community.aws.ec2_eip_module.rst | 23 +- docs/community.aws.ec2_elb_info_module.rst | 35 +- ...e.rst => community.aws.ec2_elb_module.rst} | 229 ++-- ...mmunity.aws.ec2_launch_template_module.rst | 27 +- docs/community.aws.ec2_lc_find_module.rst | 24 +- docs/community.aws.ec2_lc_info_module.rst | 24 +- docs/community.aws.ec2_lc_module.rst | 24 +- .../community.aws.ec2_metric_alarm_module.rst | 23 +- ...ty.aws.ec2_placement_group_info_module.rst | 23 +- ...mmunity.aws.ec2_placement_group_module.rst | 23 +- ...ommunity.aws.ec2_scaling_policy_module.rst | 23 +- ...community.aws.ec2_snapshot_copy_module.rst | 24 +- ...ty.aws.ec2_transit_gateway_info_module.rst | 25 +- ...mmunity.aws.ec2_transit_gateway_module.rst | 25 +- ...ommunity.aws.ec2_vpc_egress_igw_module.rst | 23 +- ...community.aws.ec2_vpc_nacl_info_module.rst | 24 +- docs/community.aws.ec2_vpc_nacl_module.rst | 26 +- docs/community.aws.ec2_vpc_peer_module.rst | 46 +- ...munity.aws.ec2_vpc_peering_info_module.rst | 24 +- ...ty.aws.ec2_vpc_route_table_info_module.rst | 23 +- ...mmunity.aws.ec2_vpc_route_table_module.rst | 23 +- .../community.aws.ec2_vpc_vgw_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vgw_module.rst | 24 +- .../community.aws.ec2_vpc_vpn_info_module.rst | 24 +- docs/community.aws.ec2_vpc_vpn_module.rst | 25 +- .../community.aws.ec2_win_password_module.rst | 24 +- docs/community.aws.ecs_attribute_module.rst | 25 +- docs/community.aws.ecs_cluster_module.rst | 24 +- docs/community.aws.ecs_ecr_module.rst | 25 +- .../community.aws.ecs_service_info_module.rst | 26 +- docs/community.aws.ecs_service_module.rst | 29 +- docs/community.aws.ecs_tag_module.rst | 25 +- docs/community.aws.ecs_task_module.rst | 27 +- ...ity.aws.ecs_taskdefinition_info_module.rst | 26 +- ...ommunity.aws.ecs_taskdefinition_module.rst | 43 +- docs/community.aws.efs_info_module.rst | 28 +- docs/community.aws.efs_module.rst | 26 +- .../community.aws.elasticache_info_module.rst | 23 +- docs/community.aws.elasticache_module.rst | 24 +- ...aws.elasticache_parameter_group_module.rst | 25 +- ...munity.aws.elasticache_snapshot_module.rst | 25 +- ...ty.aws.elasticache_subnet_group_module.rst | 155 +-- ...ity.aws.elb_application_lb_info_module.rst | 60 +- ...ommunity.aws.elb_application_lb_module.rst | 43 +- ...mmunity.aws.elb_classic_lb_info_module.rst | 25 +- docs/community.aws.elb_classic_lb_module.rst | 843 ++++++++++++++ docs/community.aws.elb_instance_module.rst | 37 +- docs/community.aws.elb_network_lb_module.rst | 43 +- ...unity.aws.elb_target_group_info_module.rst | 24 +- .../community.aws.elb_target_group_module.rst | 24 +- docs/community.aws.elb_target_info_module.rst | 25 +- docs/community.aws.elb_target_module.rst | 23 +- docs/community.aws.execute_lambda_module.rst | 24 +- docs/community.aws.iam_cert_module.rst | 24 +- docs/community.aws.iam_group_module.rst | 25 +- ...ommunity.aws.iam_managed_policy_module.rst | 25 +- ...mmunity.aws.iam_mfa_device_info_module.rst | 25 +- docs/community.aws.iam_module.rst | 35 +- ...mmunity.aws.iam_password_policy_module.rst | 25 +- docs/community.aws.iam_policy_info_module.rst | 23 +- docs/community.aws.iam_policy_module.rst | 23 +- docs/community.aws.iam_role_info_module.rst | 24 +- docs/community.aws.iam_role_module.rst | 27 +- ...mmunity.aws.iam_saml_federation_module.rst | 24 +- ...aws.iam_server_certificate_info_module.rst | 25 +- docs/community.aws.iam_user_info_module.rst | 25 +- docs/community.aws.iam_user_module.rst | 25 +- docs/community.aws.kinesis_stream_module.rst | 24 +- docs/community.aws.lambda_alias_module.rst | 24 +- docs/community.aws.lambda_event_module.rst | 24 +- docs/community.aws.lambda_facts_module.rst | 24 +- docs/community.aws.lambda_info_module.rst | 24 +- docs/community.aws.lambda_module.rst | 26 +- docs/community.aws.lambda_policy_module.rst | 24 +- docs/community.aws.lightsail_module.rst | 24 +- ...community.aws.rds_instance_info_module.rst | 25 +- docs/community.aws.rds_instance_module.rst | 25 +- docs/community.aws.rds_module.rst | 38 +- docs/community.aws.rds_param_group_module.rst | 24 +- ...community.aws.rds_snapshot_info_module.rst | 24 +- docs/community.aws.rds_snapshot_module.rst | 24 +- .../community.aws.rds_subnet_group_module.rst | 23 +- ...redshift_cross_region_snapshots_module.rst | 25 +- docs/community.aws.redshift_info_module.rst | 24 +- docs/community.aws.redshift_module.rst | 24 +- ...unity.aws.redshift_subnet_group_module.rst | 26 +- ...munity.aws.route53_health_check_module.rst | 24 +- docs/community.aws.route53_info_module.rst | 23 +- docs/community.aws.route53_module.rst | 25 +- docs/community.aws.route53_zone_module.rst | 24 +- ...nity.aws.s3_bucket_notification_module.rst | 24 +- docs/community.aws.s3_lifecycle_module.rst | 23 +- docs/community.aws.s3_logging_module.rst | 23 +- ...ty.aws.s3_metrics_configuration_module.rst | 23 +- docs/community.aws.s3_sync_module.rst | 31 +- docs/community.aws.s3_website_module.rst | 24 +- docs/community.aws.sns_module.rst | 25 +- docs/community.aws.sns_topic_module.rst | 43 +- docs/community.aws.sqs_queue_module.rst | 26 +- docs/community.aws.sts_assume_role_module.rst | 25 +- ...community.aws.sts_session_token_module.rst | 25 +- ...community.aws.wafv2_ip_set_info_module.rst | 25 +- docs/community.aws.wafv2_ip_set_module.rst | 25 +- ...munity.aws.wafv2_resources_info_module.rst | 25 +- docs/community.aws.wafv2_resources_module.rst | 25 +- ...unity.aws.wafv2_rule_group_info_module.rst | 25 +- .../community.aws.wafv2_rule_group_module.rst | 25 +- ...ommunity.aws.wafv2_web_acl_info_module.rst | 25 +- docs/community.aws.wafv2_web_acl_module.rst | 25 +- galaxy.yml | 4 +- meta/runtime.yml | 11 +- plugins/modules/aws_msk_cluster.py | 1 + plugins/modules/aws_msk_config.py | 3 + plugins/modules/cloudfront_distribution.py | 3 +- plugins/modules/dynamodb_table.py | 4 +- plugins/modules/ec2_eip.py | 5 +- plugins/modules/elasticache_subnet_group.py | 248 ++-- plugins/modules/elb_target_group.py | 28 - ...{iam_server_certificate.py => iam_cert.py} | 37 +- plugins/modules/rds_instance_info.py | 5 - plugins/modules/redshift_subnet_group.py | 281 ++--- plugins/modules/route53.py | 1 - plugins/modules/sns_topic.py | 105 +- requirements.txt | 9 +- test-requirements.txt | 6 - tests/config.yml | 2 - tests/integration/constraints.txt | 8 +- tests/integration/requirements.txt | 11 +- .../targets/aws_msk_cluster/tasks/main.yml | 72 +- .../targets/aws_msk_config/tasks/main.yml | 295 ++--- .../tasks/bucket_ownership_controls.yml | 2 +- .../targets/dynamodb_table/aliases | 1 - .../targets/dynamodb_table/defaults/main.yml | 47 - .../targets/dynamodb_table/meta/main.yml | 2 - .../targets/dynamodb_table/tasks/main.yml | 733 ------------ .../targets/ec2_eip/tasks/main.yml | 25 - tests/integration/targets/elasticache/aliases | 2 + .../targets/elasticache_subnet_group/aliases | 1 - .../defaults/main.yml | 42 - .../elasticache_subnet_group/meta/main.yml | 3 - .../elasticache_subnet_group/tasks/main.yml | 681 ----------- .../targets/elb_target/tasks/ec2_target.yml | 160 +-- .../targets/iam_server_certificate/aliases | 3 - .../iam_server_certificate/defaults/main.yml | 1 - .../iam_server_certificate/meta/main.yml | 3 - .../iam_server_certificate/tasks/main.yml | 34 - .../targets/redshift_subnet_group/aliases | 1 - .../redshift_subnet_group/defaults/main.yml | 42 - .../redshift_subnet_group/meta/main.yml | 3 - .../redshift_subnet_group/tasks/main.yml | 692 ----------- .../targets/route53/tasks/main.yml | 65 -- .../setup_botocore_pip/defaults/main.yml | 2 - .../setup_botocore_pip/handlers/main.yml | 2 - .../setup_botocore_pip/tasks/cleanup.yml | 5 - .../targets/setup_botocore_pip/tasks/main.yml | 42 - .../targets/setup_ec2_facts/defaults/main.yml | 3 - .../targets/setup_ec2_facts/tasks/main.yml | 53 - .../setup_sshkey/files/ec2-fingerprint.py | 33 - .../targets/setup_sshkey/tasks/main.yml | 71 -- .../targets/sns_topic/tasks/main.yml | 6 +- tests/requirements.yml | 4 +- tests/sanity/ignore-2.13.txt | 3 - tests/unit/constraints.txt | 7 - tests/unit/requirements.txt | 7 +- 273 files changed, 3665 insertions(+), 7965 deletions(-) delete mode 100644 bindep.txt delete mode 100644 changelogs/fragments/0-copy_ignore_txt.yml create mode 100644 changelogs/fragments/499-elb-module-add-ip_address_type_option.yml create mode 100644 changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml create mode 100644 changelogs/fragments/564-route53-retries.yml create mode 100644 changelogs/fragments/574-ecs_taskdefinition-improvement.yml create mode 100644 changelogs/fragments/586-elb-renames.yml create mode 100644 changelogs/fragments/592-sqs_queue-idempotent.yml delete mode 100644 changelogs/fragments/595-fix-route53-identifer.yaml create mode 100644 changelogs/fragments/600-ecs-task-defination-env-file-validations.yml create mode 100644 changelogs/fragments/614-ec2_vpc_peer-tagging.yml create mode 100644 changelogs/fragments/616-ec2_vpc_route_table-tagging.yml create mode 100644 changelogs/fragments/629-imports-cleanup.yml create mode 100644 changelogs/fragments/648-kms_info.yml create mode 100644 changelogs/fragments/659-checkmode.yml create mode 100644 changelogs/fragments/663-deprecate-rds.yml create mode 100644 changelogs/fragments/664-deprecate-iam.yml delete mode 100644 changelogs/fragments/670-elb_target_group-new_attriibutes.yml create mode 100644 changelogs/fragments/675-boto3-minimums.yml create mode 100644 changelogs/fragments/681-aws_secret-deletion-idempotency.yml create mode 100644 changelogs/fragments/682-aws_s3_bucket_info-botocore.yml create mode 100644 changelogs/fragments/686-pylint.yml create mode 100644 changelogs/fragments/688-pylint.yml create mode 100644 changelogs/fragments/692-s3_sync-individual-file-path.yml create mode 100644 changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml delete mode 100644 changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml delete mode 100644 changelogs/fragments/724-redshift_subnet_group-boto3.yml delete mode 100644 changelogs/fragments/728-iam_cert.yml delete mode 100644 changelogs/fragments/731-ec2_eip-not_in_vpc.yml delete mode 100644 changelogs/fragments/735-iam_server_certificate-file-names.yml delete mode 100644 changelogs/fragments/739-sns_topic-delivery_policy-shape.yml create mode 100644 changelogs/fragments/deprecate_ec2_inv_script.yml create mode 100644 changelogs/fragments/migrate_ec2_instance.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_endpoint.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_igw.yml create mode 100644 changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml create mode 100644 changelogs/fragments/rename-connection-retries.yml create mode 100644 changelogs/fragments/sns_topic_type.yml delete mode 100644 docs/community.aws.aws_msk_cluster_module.rst delete mode 100644 docs/community.aws.aws_msk_config_module.rst rename docs/{community.aws.efs_tag_module.rst => community.aws.ec2_elb_module.rst} (72%) create mode 100644 docs/community.aws.elb_classic_lb_module.rst rename plugins/modules/{iam_server_certificate.py => iam_cert.py} (88%) delete mode 100644 tests/config.yml delete mode 100644 tests/integration/targets/dynamodb_table/aliases delete mode 100644 tests/integration/targets/dynamodb_table/defaults/main.yml delete mode 100644 tests/integration/targets/dynamodb_table/meta/main.yml delete mode 100644 tests/integration/targets/dynamodb_table/tasks/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/aliases delete mode 100644 tests/integration/targets/elasticache_subnet_group/defaults/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/meta/main.yml delete mode 100644 tests/integration/targets/elasticache_subnet_group/tasks/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/aliases delete mode 100644 tests/integration/targets/iam_server_certificate/defaults/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/meta/main.yml delete mode 100644 tests/integration/targets/iam_server_certificate/tasks/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/aliases delete mode 100644 tests/integration/targets/redshift_subnet_group/defaults/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/meta/main.yml delete mode 100644 tests/integration/targets/redshift_subnet_group/tasks/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/defaults/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/handlers/main.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml delete mode 100644 tests/integration/targets/setup_botocore_pip/tasks/main.yml delete mode 100644 tests/integration/targets/setup_ec2_facts/defaults/main.yml delete mode 100644 tests/integration/targets/setup_ec2_facts/tasks/main.yml delete mode 100644 tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py delete mode 100644 tests/integration/targets/setup_sshkey/tasks/main.yml delete mode 100644 tests/sanity/ignore-2.13.txt delete mode 100644 tests/unit/constraints.txt diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3c330f1d0f6..3a5c31399fd 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,126 +5,6 @@ community.aws Release Notes .. contents:: Topics -v2.0.0 -====== - -Major Changes -------------- - -- community.aws collection - The community.aws collection has dropped support for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). - -Minor Changes -------------- - -- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) -- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). -- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). -- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). -- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). -- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). -- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). -- elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). -- elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). -- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). -- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). -- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). -- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). -- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). -- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). -- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). -- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). -- sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). -- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). -- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) -- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). -- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - -Breaking Changes / Porting Guide --------------------------------- - -- ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. -- ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. -- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint``. -- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. -- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. -- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw``. -- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. -- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_igw_info``. -- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. -- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. -- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. -- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - -Deprecated Features -------------------- - -- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). -- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. -- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). -- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). -- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. - -Bugfixes --------- - -- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). -- aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries -- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). -- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). -- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). -- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). -- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). -- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). -- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). -- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). -- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). - -New Modules ------------ - -- aws_msk_cluster - Manage Amazon MSK clusters. -- aws_msk_config - Manage Amazon MSK cluster configurations. -- efs_tag - create and remove tags on Amazon EFS resources - v1.5.0 ====== diff --git a/README.md b/README.md index a04e88b9e9d..6c2e3fafdc9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ As the AWS SDK for Python (Boto3 and Botocore) has [ceased supporting Python 2.7 Starting with the 2.0.0 releases of amazon.aws and community.aws, it is generally the collection's policy to support the versions of `botocore` and `boto3` that were released 12 months prior to the most recent major collection release, following semantic versioning (for example, 2.0.0, 3.0.0). -Version 2.0.0 of this collection supports `boto3 >= 1.15.0` and `botocore >= 1.18.0` +Version 2.0.0 of this collection supports `boto3 >= 1.13.0` and `botocore >= 1.16.0` ## Included content @@ -59,8 +59,6 @@ Name | Description [community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets [community.aws.aws_kms](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_module.rst)|Perform various KMS management tasks. [community.aws.aws_kms_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_kms_info_module.rst)|Gather information about AWS KMS keys -[community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters. -[community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations. [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions. [community.aws.aws_s3_bucket_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_bucket_info_module.rst)|lists S3 buckets in AWS [community.aws.aws_s3_cors](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_cors_module.rst)|Manage CORS for S3 buckets in AWS @@ -100,7 +98,10 @@ Name | Description [community.aws.ec2_customer_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_customer_gateway_info_module.rst)|Gather information about customer gateways in AWS [community.aws.ec2_eip](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_module.rst)|manages EC2 elastic IP (EIP) addresses. [community.aws.ec2_eip_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_info_module.rst)|List EC2 EIP details +[community.aws.ec2_elb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.ec2_elb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_elb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS +[community.aws.ec2_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_module.rst)|Create & manage EC2 instances +[community.aws.ec2_instance_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_instance_info_module.rst)|Gather information about ec2 instances in AWS [community.aws.ec2_launch_template](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_launch_template_module.rst)|Manage EC2 launch templates [community.aws.ec2_lc](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_module.rst)|Create or delete AWS Autoscaling Launch Configurations [community.aws.ec2_lc_find](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_find_module.rst)|Find AWS Autoscaling Launch Configurations @@ -113,8 +114,15 @@ Name | Description [community.aws.ec2_transit_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_module.rst)|Create and delete AWS Transit Gateways [community.aws.ec2_transit_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_info_module.rst)|Gather information about ec2 transit gateways in AWS [community.aws.ec2_vpc_egress_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_egress_igw_module.rst)|Manage an AWS VPC Egress Only Internet gateway +[community.aws.ec2_vpc_endpoint](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_module.rst)|Create and delete AWS VPC Endpoints. +[community.aws.ec2_vpc_endpoint_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_info_module.rst)|Retrieves AWS VPC endpoints details using AWS methods. +[community.aws.ec2_vpc_endpoint_service_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_endpoint_service_info_module.rst)|retrieves AWS VPC endpoint service details +[community.aws.ec2_vpc_igw](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_module.rst)|Manage an AWS VPC Internet gateway +[community.aws.ec2_vpc_igw_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_igw_info_module.rst)|Gather information about internet gateways in AWS [community.aws.ec2_vpc_nacl](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_module.rst)|create and delete Network ACLs. [community.aws.ec2_vpc_nacl_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nacl_info_module.rst)|Gather information about Network ACLs in an AWS VPC +[community.aws.ec2_vpc_nat_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_module.rst)|Manage AWS VPC NAT Gateways. +[community.aws.ec2_vpc_nat_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst)|Retrieves AWS VPC Managed Nat Gateway details using AWS methods. [community.aws.ec2_vpc_peer](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peer_module.rst)|create, delete, accept, and reject VPC peering connections between two VPCs. [community.aws.ec2_vpc_peering_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_peering_info_module.rst)|Retrieves AWS VPC Peering details using AWS methods. [community.aws.ec2_vpc_route_table](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_route_table_module.rst)|Manage route tables for AWS virtual private clouds @@ -135,7 +143,6 @@ Name | Description [community.aws.ecs_taskdefinition_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_taskdefinition_info_module.rst)|Describe a task definition in ECS [community.aws.efs](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_module.rst)|create and maintain EFS file systems [community.aws.efs_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_info_module.rst)|Get information about Amazon EFS file systems -[community.aws.efs_tag](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.efs_tag_module.rst)|create and remove tags on Amazon EFS resources [community.aws.elasticache](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_module.rst)|Manage cache clusters in Amazon ElastiCache [community.aws.elasticache_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_info_module.rst)|Retrieve information for AWS ElastiCache clusters [community.aws.elasticache_parameter_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_parameter_group_module.rst)|Manage cache parameter groups in Amazon ElastiCache. @@ -143,6 +150,7 @@ Name | Description [community.aws.elasticache_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_subnet_group_module.rst)|manage ElastiCache subnet groups [community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application Load Balancer [community.aws.elb_application_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_info_module.rst)|Gather information about application ELBs in AWS +[community.aws.elb_classic_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_module.rst)|Creates or destroys Amazon ELB. [community.aws.elb_classic_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS [community.aws.elb_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_instance_module.rst)|De-registers or registers instances from EC2 ELBs [community.aws.elb_network_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_network_lb_module.rst)|Manage a Network Load Balancer diff --git a/bindep.txt b/bindep.txt deleted file mode 100644 index a336e642f5f..00000000000 --- a/bindep.txt +++ /dev/null @@ -1,4 +0,0 @@ -# Needed for generating EC2 format fingerprints -openssl [test platform:rpm] -gcc [test platform:rpm] -python3-devel [test platform:rpm] diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index ca10bd97e9e..1dfb7e79f32 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1125,222 +1125,3 @@ releases: name: wafv2_web_acl_info namespace: '' release_date: '2021-04-27' - 2.0.0: - changes: - breaking_changes: - - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_instance``. - - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_instance_info``. - - ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint``. - - ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. - - ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. - - ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. - - ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. - Playbooks using the Fully Qualified Collection Name for this module should - be updated to use ``amazon.aws.ec2_vpc_igw``. - - ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_igw_info``. - - ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_igw_info``. - - ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway``. - - ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. - - ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` - collection. Playbooks using the Fully Qualified Collection Name for this module - should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. - - kms_info - key details are now returned in the ``kms_keys`` attribute rather - than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - bugfixes: - - aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). - - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict - with task retries - - ec2_vpc_peer - automatically retry when attempting to tag freshly created - peering connections (https://github.com/ansible-collections/community.aws/pull/614). - - ec2_vpc_route_table - automatically retry when attempting to modify freshly - created route tables (https://github.com/ansible-collections/community.aws/pull/616). - - ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). - - ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). - - ecs_taskdefinition - fix typo in ecs task defination for env file validations - (https://github.com/ansible-collections/community.aws/pull/600). - - iam_role - Modified iam_role internal code to replace update_role_description - with update_role (https://github.com/ansible-collections/community.aws/pull/697). - - route53 - fix typo in waiter configuration that prevented management of the - delays (https://github.com/ansible-collections/community.aws/pull/564). - - s3_sync - fix handling individual file path to upload a individual file to - s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). - - sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). - deprecated_features: - - ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` - module which functions identically. The original ``ec2_elb`` name is now deprecated - and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). - - ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated - in favour of the boto3 based ``elb_classic_lb_info`` module. The ``ec2_elb_info`` - module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). - - elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected - to the ``amazon.aws.ec2_elb_lb`` module which functions identically. - - iam - the boto based ``iam`` module has been deprecated in favour of the boto3 - based ``iam_user``, ``iam_group`` and ``iam_role`` modules. The ``iam`` module - will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). - - rds - the boto based ``rds`` module has been deprecated in favour of the boto3 - based ``rds_instance`` module. The ``rds`` module will be removed in release - 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). - - script_inventory_ec2 - The ec2.py inventory script is being moved to a new - repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py - and will be removed from this collection in the 3.0 release. We recommend - migrating from the script to the `amazon.aws.ec2` inventory plugin. - major_changes: - - community.aws collection - The community.aws collection has dropped support - for ``botocore<1.18.0`` and ``boto3<1.15.0`` (https://github.com/ansible-collections/community.aws/pull/711). - Most modules will continue to work with older versions of the AWS SDK, however - compatability with older versions of the SDK is not guaranteed and will not - be tested. When using older versions of the SDK a warning will be emitted - by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). - minor_changes: - - aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch - bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) - - aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudformation_stack_set - Tests for compatability with older versions of - the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - dynamodb_table - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_asg - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - ec2_launch_template - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - ec2_transit_gateway - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_transit_gateway_info - Tests for compatability with older versions of - the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). - - ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). - - ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). - - ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). - - ecs_ecr - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_service - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_task - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). - - ecs_taskdefinition - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - efs - Tests for compatability with older versions of the AWS SDKs have been - removed (https://github.com/ansible-collections/community.aws/pull/675). - - efs_info - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - elasticache_subnet_group - add return values (https://github.com/ansible-collections/community.aws/pull/723). - - elasticache_subnet_group - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/723). - - elasticache_subnet_group - module migrated to boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/723). - - elb_application_lb - added ``ip_address_type`` parameter to support changing - application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). - - elb_application_lb_info - added ``ip_address_type`` in output when gathering - application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). - - elb_instance - make elb_instance idempotent when deregistering instances. Merged - from ec2_elb U(https://github.com/ansible/ansible/pull/31660). - - elb_network_lb - added ``ip_address_type`` parameter to support changing network - load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). - - elb_target_group - Tests for compatability with older versions of the AWS - SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - iam_role - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - kms_info - added a new ``keys_attr`` parameter to continue returning the key - details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). - - lambda - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - rds_instance - Tests for compatability with older versions of the AWS SDKs - have been removed (https://github.com/ansible-collections/community.aws/pull/675). - - rds_instance - convert ``preferred_maintenance_window`` days into lowercase - so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). - - rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). - - route53 - add rate-limiting retries while waiting for changes to propagate - (https://github.com/ansible-collections/community.aws/pull/564). - - route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). - - route53 - update retry ``max_delay`` setting so that it can be set above 60 - seconds (https://github.com/ansible-collections/community.aws/pull/564). - - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either - FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). - - sqs_queue - Tests for compatability with older versions of the AWS SDKs have - been removed (https://github.com/ansible-collections/community.aws/pull/675). - - various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) - - wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - - wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). - fragments: - - 499-elb-module-add-ip_address_type_option.yml - - 516-rds_instance-preferred_maintenance_window.yml - - 564-route53-retries.yml - - 574-ecs_taskdefinition-improvement.yml - - 586-elb-renames.yml - - 592-sqs_queue-idempotent.yml - - 600-ecs-task-defination-env-file-validations.yml - - 614-ec2_vpc_peer-tagging.yml - - 616-ec2_vpc_route_table-tagging.yml - - 629-imports-cleanup.yml - - 648-kms_info.yml - - 659-checkmode.yml - - 663-deprecate-rds.yml - - 664-deprecate-iam.yml - - 675-boto3-minimums.yml - - 675-boto3-minimums.yml - - 681-aws_secret-deletion-idempotency.yml - - 682-aws_s3_bucket_info-botocore.yml - - 686-pylint.yml - - 688-pylint.yml - - 692-s3_sync-individual-file-path.yml - - 697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml - - 723-elasticache_subnet_group-boto3.yml - - deprecate_ec2_inv_script.yml - - migrate_ec2_instance.yml - - migrate_ec2_vpc_endpoint.yml - - migrate_ec2_vpc_igw.yml - - migrate_ec2_vpc_nat_gateway.yml - - rename-connection-retries.yml - - sns_topic_type.yml - modules: - - description: Manage Amazon MSK clusters. - name: aws_msk_cluster - namespace: '' - - description: Manage Amazon MSK cluster configurations. - name: aws_msk_config - namespace: '' - - description: create and remove tags on Amazon EFS resources - name: efs_tag - namespace: '' - release_date: '2021-09-14' diff --git a/changelogs/fragments/0-copy_ignore_txt.yml b/changelogs/fragments/0-copy_ignore_txt.yml deleted file mode 100644 index ec804d278dd..00000000000 --- a/changelogs/fragments/0-copy_ignore_txt.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Copy ignore.txt. diff --git a/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml b/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml new file mode 100644 index 00000000000..afc1f939be0 --- /dev/null +++ b/changelogs/fragments/499-elb-module-add-ip_address_type_option.yml @@ -0,0 +1,4 @@ +minor_changes: +- elb_application_lb - added ``ip_address_type`` parameter to support changing application load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_network_lb - added ``ip_address_type`` parameter to support changing network load balancer configuration (https://github.com/ansible-collections/community.aws/pull/499). +- elb_application_lb_info - added ``ip_address_type`` in output when gathering application load balancer parameters (https://github.com/ansible-collections/community.aws/pull/499). diff --git a/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml b/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml new file mode 100644 index 00000000000..c986d684cbc --- /dev/null +++ b/changelogs/fragments/516-rds_instance-preferred_maintenance_window.yml @@ -0,0 +1,2 @@ +minor_changes: +- rds_instance - convert ``preferred_maintenance_window`` days into lowercase so changed returns properly (https://github.com/ansible-collections/community.aws/pull/516). diff --git a/changelogs/fragments/564-route53-retries.yml b/changelogs/fragments/564-route53-retries.yml new file mode 100644 index 00000000000..46a99b56be2 --- /dev/null +++ b/changelogs/fragments/564-route53-retries.yml @@ -0,0 +1,6 @@ +bugfixes: +- route53 - fix typo in waiter configuration that prevented management of the delays (https://github.com/ansible-collections/community.aws/pull/564). +minor_changes: +- route53 - add retries on ``PriorRequestNotComplete`` errors (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - update retry ``max_delay`` setting so that it can be set above 60 seconds (https://github.com/ansible-collections/community.aws/pull/564). +- route53 - add rate-limiting retries while waiting for changes to propagate (https://github.com/ansible-collections/community.aws/pull/564). diff --git a/changelogs/fragments/574-ecs_taskdefinition-improvement.yml b/changelogs/fragments/574-ecs_taskdefinition-improvement.yml new file mode 100644 index 00000000000..c8667401464 --- /dev/null +++ b/changelogs/fragments/574-ecs_taskdefinition-improvement.yml @@ -0,0 +1,3 @@ +bugfixes: +- ecs_taskdefinition - ensure cast to integer (https://github.com/ansible-collections/community.aws/pull/574). +- ecs_taskdefinition - fix idempotency (https://github.com/ansible-collections/community.aws/pull/574). diff --git a/changelogs/fragments/586-elb-renames.yml b/changelogs/fragments/586-elb-renames.yml new file mode 100644 index 00000000000..0b799f0c0f6 --- /dev/null +++ b/changelogs/fragments/586-elb-renames.yml @@ -0,0 +1,8 @@ +minor_changes: +- elb_instance - make elb_instance idempotent when deregistering instances. Merged from ec2_elb U(https://github.com/ansible/ansible/pull/31660). +deprecated_features: +- ec2_elb - the ``ec2_elb`` module has been removed and redirected to the ``elb_instance`` module which functions identically. + The original ``ec2_elb`` name is now deprecated and will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- ec2_elb_info - the boto based ``ec2_elb_info`` module has been deprecated in favour of the boto3 based ``elb_classic_lb_info`` module. + The ``ec2_elb_info`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/586). +- elb_classic_lb - the ``elb_classic_lb`` module has been removed and redirected to the ``amazon.aws.ec2_elb_lb`` module which functions identically. diff --git a/changelogs/fragments/592-sqs_queue-idempotent.yml b/changelogs/fragments/592-sqs_queue-idempotent.yml new file mode 100644 index 00000000000..94bd5ef2388 --- /dev/null +++ b/changelogs/fragments/592-sqs_queue-idempotent.yml @@ -0,0 +1,2 @@ +bugfixes: +- sqs_queue - fix queue attribute comparison to make module idempotent (https://github.com/ansible-collections/community.aws/pull/592). diff --git a/changelogs/fragments/595-fix-route53-identifer.yaml b/changelogs/fragments/595-fix-route53-identifer.yaml deleted file mode 100644 index 11901c1655b..00000000000 --- a/changelogs/fragments/595-fix-route53-identifer.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). diff --git a/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml b/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml new file mode 100644 index 00000000000..e9186e00354 --- /dev/null +++ b/changelogs/fragments/600-ecs-task-defination-env-file-validations.yml @@ -0,0 +1,2 @@ +bugfixes: +- ecs_taskdefinition - fix typo in ecs task defination for env file validations (https://github.com/ansible-collections/community.aws/pull/600). diff --git a/changelogs/fragments/614-ec2_vpc_peer-tagging.yml b/changelogs/fragments/614-ec2_vpc_peer-tagging.yml new file mode 100644 index 00000000000..1e76f6b86ab --- /dev/null +++ b/changelogs/fragments/614-ec2_vpc_peer-tagging.yml @@ -0,0 +1,4 @@ +bugfixes: +- ec2_vpc_peer - automatically retry when attempting to tag freshly created peering connections (https://github.com/ansible-collections/community.aws/pull/614). +minor_changes: +- ec2_vpc_peer - use shared code for tagging peering connections (https://github.com/ansible-collections/community.aws/pull/614). diff --git a/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml b/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml new file mode 100644 index 00000000000..44ff49b8b38 --- /dev/null +++ b/changelogs/fragments/616-ec2_vpc_route_table-tagging.yml @@ -0,0 +1,4 @@ +bugfixes: +- ec2_vpc_route_table - automatically retry when attempting to modify freshly created route tables (https://github.com/ansible-collections/community.aws/pull/616). +minor_changes: +- ec2_vpc_route_table - use shared code for tagging route tables (https://github.com/ansible-collections/community.aws/pull/616). diff --git a/changelogs/fragments/629-imports-cleanup.yml b/changelogs/fragments/629-imports-cleanup.yml new file mode 100644 index 00000000000..211aea45988 --- /dev/null +++ b/changelogs/fragments/629-imports-cleanup.yml @@ -0,0 +1,2 @@ +minor_changes: +- various community.aws modules - remove unused imports (https://github.com/ansible-collections/community.aws/pull/629) diff --git a/changelogs/fragments/648-kms_info.yml b/changelogs/fragments/648-kms_info.yml new file mode 100644 index 00000000000..8589c07cf4c --- /dev/null +++ b/changelogs/fragments/648-kms_info.yml @@ -0,0 +1,4 @@ +minor_changes: +- kms_info - added a new ``keys_attr`` parameter to continue returning the key details in the ``keys`` attribute as well as the ``kms_keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). +breaking_changes: +- kms_info - key details are now returned in the ``kms_keys`` attribute rather than the ``keys`` attribute (https://github.com/ansible-collections/community.aws/pull/648). diff --git a/changelogs/fragments/659-checkmode.yml b/changelogs/fragments/659-checkmode.yml new file mode 100644 index 00000000000..dc9c541bb21 --- /dev/null +++ b/changelogs/fragments/659-checkmode.yml @@ -0,0 +1,10 @@ +minor_changes: +- aws_sgw_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_asg_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- ec2_lc_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_mfa_device_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- iam_server_certificate_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- wafv2_resources_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- wafv2_web_acl_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudformation_exports_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). +- cloudfront_info - ensure module runs in check_mode (https://github.com/ansible-collections/community.aws/issues/659). diff --git a/changelogs/fragments/663-deprecate-rds.yml b/changelogs/fragments/663-deprecate-rds.yml new file mode 100644 index 00000000000..787a090903d --- /dev/null +++ b/changelogs/fragments/663-deprecate-rds.yml @@ -0,0 +1,3 @@ +deprecated_features: +- rds - the boto based ``rds`` module has been deprecated in favour of the boto3 based ``rds_instance`` module. + The ``rds`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/663). diff --git a/changelogs/fragments/664-deprecate-iam.yml b/changelogs/fragments/664-deprecate-iam.yml new file mode 100644 index 00000000000..b3dcc3665c2 --- /dev/null +++ b/changelogs/fragments/664-deprecate-iam.yml @@ -0,0 +1,3 @@ +deprecated_features: +- iam - the boto based ``iam`` module has been deprecated in favour of the boto3 based ``iam_user``, ``iam_group`` and ``iam_role`` modules. + The ``iam`` module will be removed in release 3.0.0 (https://github.com/ansible-collections/community.aws/pull/664). diff --git a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml b/changelogs/fragments/670-elb_target_group-new_attriibutes.yml deleted file mode 100644 index bff32308d56..00000000000 --- a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). - - elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). \ No newline at end of file diff --git a/changelogs/fragments/675-boto3-minimums.yml b/changelogs/fragments/675-boto3-minimums.yml new file mode 100644 index 00000000000..359636714d4 --- /dev/null +++ b/changelogs/fragments/675-boto3-minimums.yml @@ -0,0 +1,26 @@ +major_changes: +- community.aws collection - The community.aws collection has dropped support for ``botocore<1.16.0`` and ``boto3<1.13.0`` (https://github.com/ansible-collections/community.aws/pull/675). + Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. + When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/442). +minor_changes: +- aws_eks_cluster - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- cloudformation_stack_set - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- dynamodb_table - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- dynamodb_ttl - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_ami_copy - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_asg - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_launch_template - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_transit_gateway - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_transit_gateway_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ec2_vpc_peer - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_ecr - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_service - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_task - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- ecs_taskdefinition - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- efs_info - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- elb_target_group - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- iam_role - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- lambda - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- rds_instance - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). +- sqs_queue - Tests for compatability with older versions of the AWS SDKs have been removed (https://github.com/ansible-collections/community.aws/pull/675). diff --git a/changelogs/fragments/681-aws_secret-deletion-idempotency.yml b/changelogs/fragments/681-aws_secret-deletion-idempotency.yml new file mode 100644 index 00000000000..ac7910ef23b --- /dev/null +++ b/changelogs/fragments/681-aws_secret-deletion-idempotency.yml @@ -0,0 +1,2 @@ +bugfixes: +- aws_secret - fix deletion idempotency when not using instant deletion (https://github.com/ansible-collections/community.aws/pull/681). diff --git a/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml b/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml new file mode 100644 index 00000000000..1577bd8d9a4 --- /dev/null +++ b/changelogs/fragments/682-aws_s3_bucket_info-botocore.yml @@ -0,0 +1,2 @@ +minor_changes: +- aws_s3_bucket_info - added test for botocore>=1.18.11 when attempting to fetch bucket ownership controls (https://github.com/ansible-collections/community.aws/pull/682) diff --git a/changelogs/fragments/686-pylint.yml b/changelogs/fragments/686-pylint.yml new file mode 100644 index 00000000000..43b91aaef88 --- /dev/null +++ b/changelogs/fragments/686-pylint.yml @@ -0,0 +1,4 @@ +minor_changes: +- ecs_task - remove unused import (https://github.com/ansible-collections/community.aws/pull/686). +- ec2_vpc_vgw - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). +- ec2_vpc_vpn - fix arguments-renamed pylint issue (https://github.com/ansible-collections/community.aws/pull/686). diff --git a/changelogs/fragments/688-pylint.yml b/changelogs/fragments/688-pylint.yml new file mode 100644 index 00000000000..6008db9cf0f --- /dev/null +++ b/changelogs/fragments/688-pylint.yml @@ -0,0 +1,10 @@ +minor_changes: +- aws_kms_info - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- aws_ses_rule_set - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- cloudwatchevent_rule - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- elb_target_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_group - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_role - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- iam_user - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). +- rds_instance - use a generator rather than list comprehension (https://github.com/ansible-collections/community.aws/pull/688). diff --git a/changelogs/fragments/692-s3_sync-individual-file-path.yml b/changelogs/fragments/692-s3_sync-individual-file-path.yml new file mode 100644 index 00000000000..77b7ac80522 --- /dev/null +++ b/changelogs/fragments/692-s3_sync-individual-file-path.yml @@ -0,0 +1,2 @@ +bugfixes: +- s3_sync - fix handling individual file path to upload a individual file to s3 bucket (https://github.com/ansible-collections/community.aws/pull/692). diff --git a/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml b/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml new file mode 100644 index 00000000000..a31b43451d9 --- /dev/null +++ b/changelogs/fragments/697-iam_role-replace-UpdateRoleDescription-with-UpdateRole.yml @@ -0,0 +1,2 @@ +bugfixes: +- iam_role - Modified iam_role internal code to replace update_role_description with update_role (https://github.com/ansible-collections/community.aws/pull/697). diff --git a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml b/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml deleted file mode 100644 index 82f82192f72..00000000000 --- a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer connections (https://github.com/ansible-collections/community.aws/pull/707). diff --git a/changelogs/fragments/724-redshift_subnet_group-boto3.yml b/changelogs/fragments/724-redshift_subnet_group-boto3.yml deleted file mode 100644 index d760eb4c2b8..00000000000 --- a/changelogs/fragments/724-redshift_subnet_group-boto3.yml +++ /dev/null @@ -1,7 +0,0 @@ -minor_changes: -- redshift_subnet_group - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_description`` option has been renamed to ``description`` and is now optional. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` and is now only required when creating a new group. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). diff --git a/changelogs/fragments/728-iam_cert.yml b/changelogs/fragments/728-iam_cert.yml deleted file mode 100644 index 9fbb3d813cb..00000000000 --- a/changelogs/fragments/728-iam_cert.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_cert - the iam_cert module has been renamed to iam_server_certificate for consistency with the companion iam_server_certificate_info module. - The usage of the module has not changed. The iam_cert alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). diff --git a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml b/changelogs/fragments/731-ec2_eip-not_in_vpc.yml deleted file mode 100644 index 4020bffd273..00000000000 --- a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). diff --git a/changelogs/fragments/735-iam_server_certificate-file-names.yml b/changelogs/fragments/735-iam_server_certificate-file-names.yml deleted file mode 100644 index 58720919f7f..00000000000 --- a/changelogs/fragments/735-iam_server_certificate-file-names.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` and ``key`` parameters has been deprecated. - We recommend using a lookup plugin to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). diff --git a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml b/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml deleted file mode 100644 index 39f60733c2a..00000000000 --- a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). diff --git a/changelogs/fragments/deprecate_ec2_inv_script.yml b/changelogs/fragments/deprecate_ec2_inv_script.yml new file mode 100644 index 00000000000..b0cc461ee58 --- /dev/null +++ b/changelogs/fragments/deprecate_ec2_inv_script.yml @@ -0,0 +1,2 @@ +deprecated_features: +- script_inventory_ec2 - The ec2.py inventory script is being moved to a new repository. The script can now be downloaded from https://github.com/ansible-community/contrib-scripts/blob/main/inventory/ec2.py and will be removed from this collection in the 3.0 release. We recommend migrating from the script to the `amazon.aws.ec2` inventory plugin. diff --git a/changelogs/fragments/migrate_ec2_instance.yml b/changelogs/fragments/migrate_ec2_instance.yml new file mode 100644 index 00000000000..fb7c0fadfe7 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_instance.yml @@ -0,0 +1,3 @@ +breaking_changes: + - ec2_instance - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance``. + - ec2_instance_info - The module has been migrated to the ``amazon.aws`` collection. Playbooks using the Fully Qualified Collection Name for this module should be updated to use ``amazon.aws.ec2_instance_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_endpoint.yml b/changelogs/fragments/migrate_ec2_vpc_endpoint.yml new file mode 100644 index 00000000000..9b10b55a905 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_endpoint.yml @@ -0,0 +1,13 @@ +breaking_changes: +- ec2_vpc_endpoint_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_endpoint``. +- ec2_vpc_endpoint_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_info``. +- ec2_vpc_endpoint_service_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_endpoint_service_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_igw.yml b/changelogs/fragments/migrate_ec2_vpc_igw.yml new file mode 100644 index 00000000000..6ab3da37409 --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_igw.yml @@ -0,0 +1,10 @@ +breaking_changes: +- ec2_vpc_igw_facts - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw_info``. +- ec2_vpc_igw - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw``. +- ec2_vpc_igw_info - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_igw_info``. diff --git a/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml b/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml new file mode 100644 index 00000000000..678e30e87cd --- /dev/null +++ b/changelogs/fragments/migrate_ec2_vpc_nat_gateway.yml @@ -0,0 +1,10 @@ +breaking_changes: +- ec2_vpc_nat_gateway_facts - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. +- ec2_vpc_nat_gateway - The module has been migrated from the ``community.aws`` collection. + Playbooks using the Fully Qualified Collection Name for this module should be updated + to use ``amazon.aws.ec2_vpc_nat_gateway``. +- ec2_vpc_nat_gateway_info - The module has been migrated from the ``community.aws`` + collection. Playbooks using the Fully Qualified Collection Name for this module + should be updated to use ``amazon.aws.ec2_vpc_nat_gateway_info``. diff --git a/changelogs/fragments/rename-connection-retries.yml b/changelogs/fragments/rename-connection-retries.yml new file mode 100644 index 00000000000..32cc97d3b9b --- /dev/null +++ b/changelogs/fragments/rename-connection-retries.yml @@ -0,0 +1,2 @@ +bugfixes: + - aws_ssm - rename ``retries`` to ``reconnection_retries`` to avoid conflict with task retries diff --git a/changelogs/fragments/sns_topic_type.yml b/changelogs/fragments/sns_topic_type.yml new file mode 100644 index 00000000000..3c57bb3be36 --- /dev/null +++ b/changelogs/fragments/sns_topic_type.yml @@ -0,0 +1,2 @@ +minor_changes: + - sns_topic - Added ``topic_type`` parameter to select type of SNS topic (either FIFO or Standard) (https://github.com/ansible-collections/community.aws/pull/599). diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.aws_acm_info_module.rst index c604a405734..45d16ff9e5e 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.aws_acm_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -178,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +194,7 @@ 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
@@ -227,7 +228,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -289,7 +290,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -301,9 +302,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_acm_module.rst b/docs/community.aws.aws_acm_module.rst index 57dbd56c4ba..29c2d490025 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.aws_acm_module.rst @@ -41,9 +41,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -285,6 +285,7 @@ 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
@@ -318,7 +319,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -360,7 +361,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -372,9 +373,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index 4f774d36cef..f1505078c9a 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -221,7 +221,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,6 +259,7 @@ 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
@@ -292,7 +293,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +450,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -463,9 +464,8 @@ Notes - A future version of this module will probably use tags or another ID so that an API can be created 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4606b53e9ae..8afeaa0e24a 100644 --- a/docs/community.aws.aws_application_scaling_policy_module.rst +++ b/docs/community.aws.aws_application_scaling_policy_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -244,6 +246,7 @@ 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
@@ -319,7 +322,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -517,7 +520,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -530,9 +533,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_compute_environment_module.rst b/docs/community.aws.aws_batch_compute_environment_module.rst index d8d542942be..01271a753d9 100644 --- a/docs/community.aws.aws_batch_compute_environment_module.rst +++ b/docs/community.aws.aws_batch_compute_environment_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -247,7 +247,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -343,6 +343,7 @@ 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
@@ -393,7 +394,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -517,7 +518,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -529,9 +530,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 93b37e4b1bc..4b821215793 100644 --- a/docs/community.aws.aws_batch_job_definition_module.rst +++ b/docs/community.aws.aws_batch_job_definition_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -413,6 +413,7 @@ 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
@@ -461,7 +462,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -598,7 +599,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -675,9 +676,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a385c7624a5..8fffc6d6d0d 100644 --- a/docs/community.aws.aws_batch_job_queue_module.rst +++ b/docs/community.aws.aws_batch_job_queue_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -194,7 +194,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -261,6 +261,7 @@ 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
@@ -294,7 +295,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +336,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -347,9 +348,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2d84d524e90..225a721095f 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -170,7 +171,7 @@ Parameters -
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.
+
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
@@ -189,7 +190,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -222,7 +223,7 @@ Parameters -
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.
+
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
@@ -324,7 +325,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -472,6 +473,7 @@ 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
@@ -505,7 +507,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -728,7 +730,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -756,9 +758,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9d30ec448f2..37f2d3bfe65 100644 --- a/docs/community.aws.aws_codecommit_module.rst +++ b/docs/community.aws.aws_codecommit_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +192,7 @@ 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
@@ -224,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -266,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -278,9 +280,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b6b2cd3c410..7dc4353b821 100644 --- a/docs/community.aws.aws_codepipeline_module.rst +++ b/docs/community.aws.aws_codepipeline_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -102,7 +103,7 @@ Parameters -
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.
+
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
@@ -121,7 +122,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -154,7 +155,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +224,7 @@ 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
@@ -272,7 +274,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -366,7 +368,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -394,9 +396,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2ce46985937..6fccefcc774 100644 --- a/docs/community.aws.aws_config_aggregation_authorization_module.rst +++ b/docs/community.aws.aws_config_aggregation_authorization_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -85,7 +86,7 @@ Parameters -
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.
+
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
@@ -104,7 +105,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -137,7 +138,7 @@ Parameters -
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.
+
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
@@ -174,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +191,7 @@ 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
@@ -223,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -264,7 +266,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -276,9 +278,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4dae621e755..174310c5eab 100644 --- a/docs/community.aws.aws_config_aggregator_module.rst +++ b/docs/community.aws.aws_config_aggregator_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -125,7 +126,7 @@ Parameters -
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.
+
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
@@ -144,7 +145,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -177,7 +178,7 @@ Parameters -
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.
+
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
@@ -214,7 +215,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -316,6 +317,7 @@ 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
@@ -349,7 +351,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -390,7 +392,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -402,9 +404,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e2940cf6c41..be94d2f101a 100644 --- a/docs/community.aws.aws_config_delivery_channel_module.rst +++ b/docs/community.aws.aws_config_delivery_channel_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -164,7 +165,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,6 +197,7 @@ 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
@@ -260,7 +262,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -316,7 +318,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -328,9 +330,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 439de0efbee..74132eb51ad 100644 --- a/docs/community.aws.aws_config_recorder_module.rst +++ b/docs/community.aws.aws_config_recorder_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -294,7 +296,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +337,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -347,9 +349,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 87e98cd929d..d33a4f33334 100644 --- a/docs/community.aws.aws_config_rule_module.rst +++ b/docs/community.aws.aws_config_rule_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -226,6 +227,7 @@ 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
@@ -339,7 +341,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +451,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +463,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 66a9fa6acb4..b105b278bbf 100644 --- a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +192,7 @@ 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
@@ -224,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +248,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cff65666871..10bf85bb695 100644 --- a/docs/community.aws.aws_direct_connect_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_connection_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +180,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -263,6 +264,7 @@ 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
@@ -296,7 +298,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -338,7 +340,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -350,9 +352,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d8bcfb3fbb4..6e4a37bd3ae 100644 --- a/docs/community.aws.aws_direct_connect_gateway_module.rst +++ b/docs/community.aws.aws_direct_connect_gateway_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -72,7 +72,7 @@ Parameters -
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.
+
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
@@ -91,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +124,7 @@ Parameters -
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.
+
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
@@ -177,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -208,6 +208,7 @@ 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
@@ -241,7 +242,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +284,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -326,9 +327,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 47a4b3f1a24..0aafe21240d 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 @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -301,6 +302,7 @@ 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
@@ -334,7 +336,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -376,7 +378,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -425,9 +427,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cac6b60f287..c959826cbce 100644 --- a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst +++ b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -98,7 +99,7 @@ Parameters -
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.
+
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
@@ -117,7 +118,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -150,7 +151,7 @@ Parameters -
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.
+
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
@@ -250,7 +251,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -298,6 +299,7 @@ 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
@@ -350,7 +352,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -392,7 +394,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -451,9 +453,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3bf9973bcdb..6a4e1be3b1c 100644 --- a/docs/community.aws.aws_eks_cluster_module.rst +++ b/docs/community.aws.aws_eks_cluster_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -238,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +297,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -357,9 +359,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3ad0c9fa24a..5ce6e64dd8d 100644 --- a/docs/community.aws.aws_elasticbeanstalk_app_module.rst +++ b/docs/community.aws.aws_elasticbeanstalk_app_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -69,7 +68,7 @@ Parameters -
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.
+
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
@@ -88,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +120,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +188,7 @@ 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
@@ -222,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +294,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 04afb555c95..2202ff9e781 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.aws_glue_connection_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -70,7 +70,7 @@ Parameters -
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.
+
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
@@ -89,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +122,7 @@ Parameters -
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.
+
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
@@ -228,7 +228,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -276,6 +276,7 @@ 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
@@ -326,7 +327,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -384,7 +385,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -396,9 +397,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 00f0e68946c..ccbb2bd55f5 100644 --- a/docs/community.aws.aws_glue_job_module.rst +++ b/docs/community.aws.aws_glue_job_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -235,7 +235,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,6 +329,7 @@ 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
@@ -378,7 +379,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -435,7 +436,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -468,9 +469,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0a58c6f0f79..19d4cda8e15 100644 --- a/docs/community.aws.aws_inspector_target_module.rst +++ b/docs/community.aws.aws_inspector_target_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -264,7 +266,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -276,9 +278,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3753a1966d6..d13db70e882 100644 --- a/docs/community.aws.aws_kms_info_module.rst +++ b/docs/community.aws.aws_kms_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -161,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -199,28 +198,6 @@ Parameters

aliases: key_arn
- - -
- keys_attr - -
- boolean -
-
added in 2.0.0
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Whether to return the results in the keys attribute as well as the kms_keys attribute.
-
Returning the keys attribute conflicts with the builtin keys() method on dictionaries and as such has been deprecated.
-
After version 3.0.0 this parameter will do nothing, and after version 4.0.0 this parameter will be removed.
- -
@@ -252,6 +229,7 @@ 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
@@ -285,7 +263,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -307,7 +285,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -319,9 +297,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -362,7 +339,7 @@ Common return values are documented `here
- kms_keys + keys
complex diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index d51bc1bb2d5..210d4fcdee7 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -69,7 +68,7 @@ Parameters -
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.
+
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
@@ -88,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +120,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -482,6 +481,7 @@ 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
@@ -553,7 +553,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -609,7 +609,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -621,9 +621,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_msk_cluster_module.rst b/docs/community.aws.aws_msk_cluster_module.rst deleted file mode 100644 index b585d1861dc..00000000000 --- a/docs/community.aws.aws_msk_cluster_module.rst +++ /dev/null @@ -1,1031 +0,0 @@ -.. _community.aws.aws_msk_cluster_module: - - -***************************** -community.aws.aws_msk_cluster -***************************** - -**Manage Amazon MSK clusters.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- authentication - -
- dictionary -
- 		- -
Includes all client authentication related information.
-
Effective only for new cluster and can not be updated.
-
-
- sasl_scram - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
SASL/SCRAM authentication is enabled or not.
-
-
- tls_ca_arn - -
- list - / elements=string -
- 		- -
List of ACM Certificate Authority ARNs.
-
-
- aws_access_key - -
- string -
- 		- -
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_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
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
-
-
- configuration_arn - -
- string -
- 		- -
ARN of the configuration to use.
-
This parameter is required when state=present.
-
-
- configuration_revision - -
- integer -
- 		- -
The revision of the configuration to use.
-
This parameter is required when state=present.
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- ebs_volume_size - -
- integer -
- 		- Default:
100
- 		-
The size in GiB of the EBS volume for the data drive on each broker node.
-
-
- ec2_url - -
- string -
- 		- -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- encryption - -
- dictionary -
- 		- -
Includes all encryption-related information.
-
Effective only for new cluster and can not be updated.
-
-
- in_transit - -
- dictionary -
- 		- -
The details for encryption in transit.
-
-
- client_broker - -
- string -
- 		-
    Choices: -
  • TLS ←
    • -
  • TLS_PLAINTEXT
    • -
  • PLAINTEXT
    • -
- 		-
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only.
-
-
- in_cluster - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
-
-
- kms_key_id - -
- string -
- 		- Default:
null
- 		-
The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
-
-
- enhanced_monitoring - -
- string -
- 		-
    Choices: -
  • DEFAULT ←
    • -
  • PER_BROKER
    • -
  • PER_TOPIC_PER_BROKER
    • -
  • PER_TOPIC_PER_PARTITION
    • -
- 		-
Specifies the level of monitoring for the MSK cluster.
-
-
- instance_type - -
- string -
- 		-
    Choices: -
  • kafka.t3.small ←
    • -
  • kafka.m5.large
    • -
  • kafka.m5.xlarge
    • -
  • kafka.m5.2xlarge
    • -
  • kafka.m5.4xlarge
    • -
- 		-
The type of Amazon EC2 instances to use for Kafka brokers.
-
Update operation requires botocore version >= 1.19.58.
-
-
- logging - -
- dictionary -
- 		- -
Logging configuration.
-
-
- cloudwatch - -
- dictionary -
- 		- -
Details of the CloudWatch Logs destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
-
-
- log_group - -
- string -
- 		- -
The CloudWatch log group that is the destination for broker logs.
-
-
- firehose - -
- dictionary -
- 		- -
Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
-
-
- delivery_stream - -
- string -
- 		- -
The Kinesis Data Firehose delivery stream that is the destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.
-
-
- s3 - -
- dictionary -
- 		- -
Details of the Amazon S3 destination for broker logs.
-
-
- bucket - -
- string -
- 		- -
The name of the S3 bucket that is the destination for broker logs.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Specifies whether broker logs get sent to the specified Amazon S3 destination.
-
-
- prefix - -
- string -
- 		- -
The S3 prefix that is the destination for broker logs.
-
-
- name - -
- string - / required -
- 		- -
The name of the cluster.
-
-
- nodes - -
- integer -
- 		- Default:
3
- 		-
The number of broker nodes in the cluster. Should be greater or equal to two.
-
-
- open_monitoring - -
- dictionary -
- 		- -
The settings for open monitoring.
-
-
- jmx_exporter - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Indicates whether you want to enable or disable the JMX Exporter.
-
-
- node_exporter - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Indicates whether you want to enable or disable the Node Exporter.
-
-
- profile - -
- string -
- 		- -
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
-
-
- purge_tags - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Remove tags not listed in tags when tags is specified.
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- security_groups - -
- list - / elements=string -
- 		- -
The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
-
-
- security_token - -
- 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
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Create (present) or delete (absent) cluster.
-
-
- subnets - -
- list - / elements=string -
- 		- -
The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.
-
Client subnets can't be in Availability Zone us-east-1e.
-
This parameter is required when state=present.
-
-
- tags - -
- dictionary -
- 		- -
Tag dictionary to apply to the cluster.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
-
- version - -
- string -
- 		- -
The version of Apache Kafka.
-
This version should exist in given configuration.
-
This parameter is required when state=present.
-
Update operation requires botocore version >= 1.16.19.
-
-
- wait - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Whether to wait for the cluster to be available or deleted.
-
-
- wait_timeout - -
- integer -
- 		- Default:
3600
- 		-
How many seconds to wait. Cluster creation can take up to 20-30 minutes.
-
-
- - -Notes ------ - -.. note:: - - All operations are time consuming, for example create takes 20-30 minutes, update kafka version -- more than one hour, update configuration -- 10-15 minutes; - - Cluster's brokers get evenly distributed over a number of availability zones that's equal to the number of subnets. - - If parameters 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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. - - - -Examples --------- - -.. code-block:: yaml - - # Note: These examples do not set authentication details, see the AWS Guide for details. - - - aws_msk_cluster: - name: kafka-cluster - state: present - version: 2.6.1 - nodes: 6 - ebs_volume_size: "{{ aws_msk_options.ebs_volume_size }}" - subnets: - - subnet-e3b48ce7c25861eeb - - subnet-2990c8b25b07ddd43 - - subnet-d9fbeaf46c54bfab6 - wait: true - wait_timeout: 1800 - configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1 - configuration_revision: 1 - - - aws_msk_cluster: - name: kafka-cluster - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- bootstrap_broker_string - -
- complex -
- 		state=present and cluster state is ACTIVE -
A list of brokers that a client application can use to bootstrap.
-
-
  -
- plain - -
- string -
- 		-
A string containing one or more hostname:port pairs.
-
-
  -
- tls - -
- string -
- 		-
A string containing one or more DNS names (or IP) and TLS port pairs.
-
-
-
- cluster_info - -
- dictionary -
- 		state=present -
Description of the MSK cluster.
-
-
-
- response - -
- dictionary -
- 		always -
The response from actual API call.
-
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_msk_config_module.rst b/docs/community.aws.aws_msk_config_module.rst deleted file mode 100644 index 37fc97d7ac0..00000000000 --- a/docs/community.aws.aws_msk_config_module.rst +++ /dev/null @@ -1,435 +0,0 @@ -.. _community.aws.aws_msk_config_module: - - -**************************** -community.aws.aws_msk_config -**************************** - -**Manage Amazon MSK cluster configurations.** - - -Version added: 2.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) cluster configurations. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- boto3 -- boto3 >= 1.15.0 -- botocore >= 1.17.48 -- botocore >= 1.18.0 -- python >= 3.6 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aws_access_key - -
- string -
- 		- -
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_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
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
-
-
- config - -
- dictionary -
- 		- -
Contents of the server.properties file.
-

aliases: configuration
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- description - -
- string -
- 		- -
The description of the configuration.
-
-
- ec2_url - -
- string -
- 		- -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- kafka_versions - -
- list - / elements=string -
- 		- -
The versions of Apache Kafka with which you can use this MSK configuration.
-
Required when state=present.
-
-
- name - -
- string - / required -
- 		- -
The name of the configuration.
-
-
- profile - -
- string -
- 		- -
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
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- security_token - -
- 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
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
Create (present) or delete (absent) cluster configuration.
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
-
- - -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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. - - - -Examples --------- - -.. code-block:: yaml - - # Note: These examples do not set authentication details, see the AWS Guide for details. - - - aws_msk_config: - name: kafka-cluster-configuration - state: present - kafka_versions: - - 2.6.0 - - 2.6.1 - config: - auto.create.topics.enable: false - num.partitions: 1 - default.replication.factor: 3 - zookeeper.session.timeout.ms: 18000 - - - aws_msk_config: - name: kafka-cluster-configuration - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- arn - -
- string -
- 		state=present -
The Amazon Resource Name (ARN) of the configuration.
-
-
Sample:
-
arn:aws:kafka:<region>:<account>:configuration/<name>/<resource-id>
-
-
- response - -
- dictionary -
- 		always -
The response from actual API call.
-
-
-
- revision - -
- integer -
- 		state=present -
The revision number.
-
-
Sample:
-
1
-
-
- server_properties - -
- string -
- 		state=present -
Contents of the server.properties file.
-
-
Sample:
-
default.replication.factor=3 - num.io.threads=8 - zookeeper.session.timeout.ms=18000
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- Daniil Kupchenko (@oukooveu) diff --git a/docs/community.aws.aws_region_info_module.rst b/docs/community.aws.aws_region_info_module.rst index 39b2d55c302..dce1b7e7fe0 100644 --- a/docs/community.aws.aws_region_info_module.rst +++ b/docs/community.aws.aws_region_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -180,6 +181,7 @@ 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
@@ -213,7 +215,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -235,7 +237,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -247,9 +249,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f004a4c533f..4e8862e3d8c 100644 --- a/docs/community.aws.aws_s3_bucket_info_module.rst +++ b/docs/community.aws.aws_s3_bucket_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -308,7 +308,6 @@ Parameters
Retrive S3 ownership controls.
-
Access to bucket ownership controls requires botocore>=1.18.11.
@@ -483,7 +482,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -533,6 +532,7 @@ 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
@@ -566,7 +566,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -610,7 +610,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -622,9 +622,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 03af570f9f7..d0ca89d016d 100644 --- a/docs/community.aws.aws_s3_cors_module.rst +++ b/docs/community.aws.aws_s3_cors_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +277,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c350a06e078..9b72a3f31a4 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.aws_secret_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore>=1.10.0 +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,6 +205,7 @@ 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
@@ -321,7 +323,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -377,7 +379,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -389,9 +391,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a439fa43a8a..9cc37367205 100644 --- a/docs/community.aws.aws_ses_identity_module.rst +++ b/docs/community.aws.aws_ses_identity_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -310,7 +311,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -363,6 +364,7 @@ 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
@@ -396,7 +398,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -437,7 +439,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -449,9 +451,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f97c858a62f..177b0f20617 100644 --- a/docs/community.aws.aws_ses_identity_policy_module.rst +++ b/docs/community.aws.aws_ses_identity_policy_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -207,6 +208,7 @@ 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
@@ -240,7 +242,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -293,9 +295,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 cf4454134db..8734e4ccac3 100644 --- a/docs/community.aws.aws_ses_rule_set_module.rst +++ b/docs/community.aws.aws_ses_rule_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -75,7 +76,7 @@ Parameters -
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.
+
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
@@ -94,7 +95,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -127,7 +128,7 @@ Parameters -
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.
+
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
@@ -164,7 +165,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -215,6 +216,7 @@ 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
@@ -248,7 +250,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -289,7 +291,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -301,9 +303,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ee750483fe2..00f665a0dab 100644 --- a/docs/community.aws.aws_sgw_info_module.rst +++ b/docs/community.aws.aws_sgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -235,6 +235,7 @@ 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
@@ -268,7 +269,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -290,7 +291,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -302,9 +303,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d88a1b506f6..5982f438b7e 100644 --- a/docs/community.aws.aws_ssm_connection.rst +++ b/docs/community.aws.aws_ssm_connection.rst @@ -137,39 +137,39 @@ Parameters
- reconnection_retries + region
- integer + -
- Default:
3
+ Default:
"us-east-1"
-
var: ansible_aws_ssm_retries
+
var: ansible_aws_ssm_region
-
Number of attempts to connect.
+
The region the EC2 instance is located.
- region + retries
- - + integer
- Default:
"us-east-1"
+ Default:
3
-
var: ansible_aws_ssm_region
+
var: ansible_aws_ssm_retries
-
The region the EC2 instance is located.
+
Number of attempts to connect.
diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.aws_ssm_parameter_store_module.rst index 76b06dcbd77..5e8a325f7bf 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/docs/community.aws.aws_ssm_parameter_store_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -176,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -245,6 +246,7 @@ 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
@@ -278,7 +280,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -361,7 +363,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -388,9 +390,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 76bdb9dc4bb..0e9159f0aca 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 @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -72,7 +71,7 @@ Parameters -
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.
+
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
@@ -91,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -124,7 +123,7 @@ Parameters -
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.
+
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
@@ -177,7 +176,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -255,6 +254,7 @@ 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
@@ -288,7 +288,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -325,7 +325,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -337,9 +337,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0706e8c3829..7a863fdcba0 100644 --- a/docs/community.aws.aws_step_functions_state_machine_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -159,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +190,7 @@ 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
@@ -259,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -315,7 +315,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +327,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 008043e9466..a22b1d2989d 100644 --- a/docs/community.aws.aws_waf_condition_module.rst +++ b/docs/community.aws.aws_waf_condition_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -437,6 +436,7 @@ 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
@@ -489,7 +489,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -555,7 +555,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -586,9 +586,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 85e18d75544..afc3aba03f5 100644 --- a/docs/community.aws.aws_waf_info_module.rst +++ b/docs/community.aws.aws_waf_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -260,9 +261,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4a122fdc547..f0a3dee30c5 100644 --- a/docs/community.aws.aws_waf_rule_module.rst +++ b/docs/community.aws.aws_waf_rule_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -222,7 +221,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -272,6 +271,7 @@ 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
@@ -324,7 +324,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -396,9 +396,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 117059745dd..b6031af80c4 100644 --- a/docs/community.aws.aws_waf_web_acl_module.rst +++ b/docs/community.aws.aws_waf_web_acl_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -162,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +211,7 @@ 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
@@ -352,7 +352,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -393,7 +393,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -424,9 +424,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9bd43334bb1..8047723c9ed 100644 --- a/docs/community.aws.cloudformation_exports_info_module.rst +++ b/docs/community.aws.cloudformation_exports_info_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.11.15 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +158,7 @@ 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
@@ -191,7 +192,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -213,7 +214,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -225,9 +226,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1ad9dd1f311..268c58f6106 100644 --- a/docs/community.aws.cloudformation_stack_set_module.rst +++ b/docs/community.aws.cloudformation_stack_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3>=1.6 +- botocore>=1.10.26 +- python >= 2.6 Parameters @@ -87,7 +88,7 @@ Parameters -
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.
+
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
@@ -106,7 +107,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -139,7 +140,7 @@ Parameters -
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.
+
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
@@ -213,7 +214,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -367,6 +368,7 @@ 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
@@ -437,7 +439,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -547,7 +549,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -596,9 +598,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4274b12a5cc..7fe2ada6fa1 100644 --- a/docs/community.aws.cloudfront_distribution_module.rst +++ b/docs/community.aws.cloudfront_distribution_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -85,7 +85,7 @@ Parameters -
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.
+
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
@@ -104,7 +104,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -137,7 +137,7 @@ Parameters -
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.
+
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
@@ -1314,7 +1314,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1719,44 +1719,10 @@ Parameters
Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront.
-
Will automatically create an Identity for you if no s3_origin_config is specified.
+
Will automatically create an Identity for you.
- - - -
- s3_origin_config - -
- dictionary -
- - - - -
Specify origin access identity for S3 origins.
- - - - - - -
- origin_access_identity - -
- string -
- - - - -
Existing origin access identity in the format origin-access-identity/cloudfront/OID_ID.
- - - @@ -1790,6 +1756,7 @@ 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
@@ -1991,7 +1958,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -2050,7 +2017,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -2217,9 +2184,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -4478,44 +4444,6 @@ Common return values are documented `here - -   -   - -
- s3_origin_config - -
- dictionary -
- - when s3_origin_access_identity_enabled is true - -
Origin access identity configuration for S3 Origin.
-
- - - -   -   -   - -
- origin_access_identity - -
- string -
- - - -
The origin access id as a path.
-
-
Sample:
-
origin-access-identity/cloudfront/EXAMPLEID
- - -   diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 9766f960ce7..3bc0915dd8d 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -73,7 +73,7 @@ Parameters -
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.
+
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
@@ -92,7 +92,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +125,7 @@ Parameters -
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.
+
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
@@ -232,7 +232,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -437,6 +437,7 @@ 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
@@ -470,7 +471,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -552,7 +553,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -564,9 +565,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1b64c27ef53..eef95720fe4 100644 --- a/docs/community.aws.cloudfront_invalidation_module.rst +++ b/docs/community.aws.cloudfront_invalidation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -68,7 +68,7 @@ Parameters -
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.
+
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
@@ -87,7 +87,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +120,7 @@ Parameters -
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.
+
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
@@ -189,7 +189,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +205,7 @@ 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
@@ -238,7 +239,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -290,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 45ffd8bb0c8..69a2da9de57 100644 --- a/docs/community.aws.cloudfront_origin_access_identity_module.rst +++ b/docs/community.aws.cloudfront_origin_access_identity_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.0.0 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -203,6 +203,7 @@ 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
@@ -236,7 +237,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -290,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3f3baa82c07..b124fa5915e 100644 --- a/docs/community.aws.cloudtrail_module.rst +++ b/docs/community.aws.cloudtrail_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -176,7 +177,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -305,6 +306,7 @@ 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
@@ -371,7 +373,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +451,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +463,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 441d276d550..ec1834b10d7 100644 --- a/docs/community.aws.cloudwatchevent_rule_module.rst +++ b/docs/community.aws.cloudwatchevent_rule_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -204,6 +204,7 @@ 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
@@ -267,7 +268,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -461,7 +462,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -475,9 +476,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6206c9deba1..3635b8f5839 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 350ac92429c..c0e448046ba 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -286,6 +287,7 @@ 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
@@ -319,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -361,7 +363,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -373,9 +375,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 17ceecb94bc..2dbc487ef7c 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,6 +211,7 @@ 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
@@ -279,7 +282,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -335,7 +338,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -348,9 +351,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 08740070baa..167cf82e78a 100644 --- a/docs/community.aws.data_pipeline_module.rst +++ b/docs/community.aws.data_pipeline_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -398,6 +398,7 @@ 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
@@ -431,7 +432,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -505,7 +506,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -581,9 +582,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 38fe9ee552f..6c1730d99e4 100644 --- a/docs/community.aws.dms_endpoint_module.rst +++ b/docs/community.aws.dms_endpoint_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -202,7 +201,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -405,6 +404,7 @@ 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
@@ -469,7 +469,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -607,7 +607,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -638,9 +638,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f6b208ddff4..25e0fa5b98d 100644 --- a/docs/community.aws.dms_replication_subnet_group_module.rst +++ b/docs/community.aws.dms_replication_subnet_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +189,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -281,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -293,9 +293,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a4c0979d3b6..8de198abe68 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -27,10 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- boto >= 2.37.0 +- boto3 >= 1.4.4 (for tagging) +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -381,6 +381,7 @@ 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
@@ -465,7 +466,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -522,7 +523,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -566,9 +567,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 50ed4076859..99a2502b13c 100644 --- a/docs/community.aws.dynamodb_ttl_module.rst +++ b/docs/community.aws.dynamodb_ttl_module.rst @@ -17,7 +17,8 @@ Version added: 1.0.0 Synopsis -------- -- Sets the TTL for a given DynamoDB table. +- Uses boto3 to set TTL. +- Requires botocore version 1.5.24 or higher. @@ -25,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore>=1.5.24 +- python >= 2.6 Parameters @@ -70,7 +72,7 @@ Parameters -
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.
+
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
@@ -89,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +124,7 @@ Parameters -
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.
+
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
@@ -159,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +177,7 @@ 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
@@ -208,7 +211,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +268,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +280,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 bb3feebab07..42c5f779dff 100644 --- a/docs/community.aws.ec2_ami_copy_module.rst +++ b/docs/community.aws.ec2_ami_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -344,7 +345,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -394,9 +395,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 64df8d3cf18..5f7e4ae800f 100644 --- a/docs/community.aws.ec2_asg_info_module.rst +++ b/docs/community.aws.ec2_asg_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +175,7 @@ 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
@@ -208,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c093c9d89a6..e950d3b0b3e 100644 --- a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst +++ b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3>=1.4.4 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -259,6 +259,7 @@ 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
@@ -307,7 +308,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -369,7 +370,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -381,9 +382,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4422e8af239..ca3cdbf4ee0 100644 --- a/docs/community.aws.ec2_asg_module.rst +++ b/docs/community.aws.ec2_asg_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -708,6 +709,7 @@ 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
@@ -792,7 +794,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -909,7 +911,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -972,9 +974,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 8034b96949c..3d08a50f855 100644 --- a/docs/community.aws.ec2_customer_gateway_info_module.rst +++ b/docs/community.aws.ec2_customer_gateway_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a38ee5dfe0c..9d81a8bcb54 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -257,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -298,7 +300,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -312,9 +314,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2cfcd570736..d742f823cc0 100644 --- a/docs/community.aws.ec2_eip_info_module.rst +++ b/docs/community.aws.ec2_eip_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +174,7 @@ 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
@@ -208,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -242,9 +242,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 921e424b8ba..dd674bbb9d4 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -73,7 +72,7 @@ Parameters -
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.
+
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
@@ -92,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +124,7 @@ Parameters -
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.
+
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
@@ -179,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -230,6 +229,7 @@ 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
@@ -334,7 +334,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -406,7 +406,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -435,9 +435,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4ccc2a76a92..7689fb8882f 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -14,13 +14,6 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The ec2_elb_info is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`elb_classic_lb_info `. - - Synopsis -------- @@ -33,10 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -62,7 +53,7 @@ Parameters -
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.
+
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
@@ -81,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -114,7 +105,7 @@ Parameters -
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.
+
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
@@ -151,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -183,6 +174,7 @@ 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
@@ -216,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -238,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -250,9 +242,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -297,10 +288,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.efs_tag_module.rst b/docs/community.aws.ec2_elb_module.rst similarity index 72% rename from docs/community.aws.efs_tag_module.rst rename to docs/community.aws.ec2_elb_module.rst index 838b239d74f..39b33d7c74b 100644 --- a/docs/community.aws.efs_tag_module.rst +++ b/docs/community.aws.ec2_elb_module.rst @@ -1,14 +1,14 @@ -.. _community.aws.efs_tag_module: +.. _community.aws.ec2_elb_module: ********************* -community.aws.efs_tag +community.aws.ec2_elb ********************* -**create and remove tags on Amazon EFS resources** +**De-registers or registers instances from EC2 ELBs** -Version added: 2.0.0 +Version added: 1.0.0 .. contents:: :local: @@ -17,8 +17,9 @@ Version added: 2.0.0 Synopsis -------- -- Creates and removes tags for Amazon EFS resources. -- Resources are referenced by their ID (filesystem or filesystem access point). +- This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. +- Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. +- Will be marked changed when called only if there are ELBs found to operate on. @@ -26,9 +27,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -134,23 +134,24 @@ Parameters
- ec2_url + ec2_elbs
- string + list + / elements=string
-
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
+
List of ELB names, required for registration.
+
The ec2_elbs fact should be used if there was a previous de-register.
- profile + ec2_url
string @@ -159,15 +160,14 @@ Parameters -
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
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
- purge_tags + enable_availability_zone
boolean @@ -175,45 +175,62 @@ Parameters
    Choices: -
  • no ←
    • -
  • yes
    • +
  • no
    • +
  • yes ←
-
Whether unspecified tags should be removed from the resource.
-
Note that when combined with state=absent, specified tags with non-matching values are not purged.
+
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
- region + instance_id
string + / required
-
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
+
EC2 Instance ID
- resource + profile
string - / required
-
EFS Filesystem ID or EFS Filesystem Access Point ID.
+
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
+ + + + +
+ region + +
+ string +
+ + + + +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
@@ -228,7 +245,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -241,39 +258,42 @@ Parameters
string + / required
    Choices: -
  • present ←
    • +
  • present
  • absent
-
Whether the tags should be present or absent on the resource.
+
register or deregister the instance
- tags + validate_certs
- dictionary - / required + boolean
+
    Choices: +
  • no
    • +
  • yes ←
    • +
-
A dictionary of tags to add or remove from the resource.
-
If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- validate_certs + wait
boolean @@ -286,7 +306,23 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
Wait for instance registration or deregistration to complete successfully before returning.
+ + + + +
+ wait_timeout + +
+ integer +
+ + + Default:
0
+ + +
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
@@ -298,9 +334,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -309,97 +344,23 @@ Examples .. code-block:: yaml - - name: Ensure tags are present on a resource - community.aws.efs_tag: - resource: fs-123456ab - state: present - tags: - Name: MyEFS - Env: Production - - - name: Remove the Env tag if it's currently 'development' - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: - Env: development - - - name: Remove all tags except for Name - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: - Name: foo - purge_tags: true - - - name: Remove all tags - community.aws.efs_tag: - resource: fsap-78945ff - state: absent - tags: {} - purge_tags: true - - + # basic pre_task and post_task example + pre_tasks: + - name: Instance De-register + community.aws.ec2_elb: + instance_id: "{{ ansible_ec2_instance_id }}" + state: absent + roles: + - myrole + post_tasks: + - name: Instance Register + community.aws.ec2_elb: + instance_id: "{{ ansible_ec2_instance_id }}" + ec2_elbs: "{{ item }}" + state: present + loop: "{{ ec2_elbs }}" -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- added_tags - -
- dictionary -
- 		If tags were added -
A dict of tags that were added to the resource
-
-
-
- removed_tags - -
- dictionary -
- 		If tags were removed -
A dict of tags that were removed from the resource
-
-
-
- tags - -
- dictionary -
- 		always -
A dict containing the tags on the resource
-
-
-

Status @@ -409,4 +370,4 @@ Status Authors ~~~~~~~ -- Milan Zink (@zeten30) +- John Jarvis (@jarv) diff --git a/docs/community.aws.ec2_launch_template_module.rst b/docs/community.aws.ec2_launch_template_module.rst index 0df31038a64..3bec3a190f9 100644 --- a/docs/community.aws.ec2_launch_template_module.rst +++ b/docs/community.aws.ec2_launch_template_module.rst @@ -18,7 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups. -- The :ref:`amazon.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. +- The :ref:`community.aws.ec2_instance ` and :ref:`community.aws.ec2_asg ` modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more. @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.6.0 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -489,7 +490,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1153,6 +1154,7 @@ 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
@@ -1233,7 +1235,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1339,7 +1341,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -1351,9 +1353,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b4ef0e22906..803e4898d12 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +194,7 @@ 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
@@ -227,7 +228,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +269,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -280,9 +281,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c69ad922727..e8b6bcecd0b 100644 --- a/docs/community.aws.ec2_lc_info_module.rst +++ b/docs/community.aws.ec2_lc_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +176,7 @@ 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
@@ -209,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -307,7 +308,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -319,9 +320,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2ce6e3fdd6f..af1f0bff3f3 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- python >= 2.6 Parameters @@ -92,7 +92,7 @@ Parameters -
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.
+
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
@@ -111,7 +111,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -144,7 +144,7 @@ Parameters -
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.
+
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
@@ -231,7 +231,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -393,6 +393,7 @@ 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
@@ -457,7 +458,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -543,7 +544,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -753,9 +754,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d55e599ddc7..c15290999b5 100644 --- a/docs/community.aws.ec2_metric_alarm_module.rst +++ b/docs/community.aws.ec2_metric_alarm_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -70,7 +69,7 @@ Parameters -
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.
+
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
@@ -89,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -122,7 +121,7 @@ Parameters -
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.
+
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
@@ -217,7 +216,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -342,6 +341,7 @@ 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
@@ -375,7 +375,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -519,7 +519,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -531,9 +531,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 afc05c66621..e231cde5eab 100644 --- a/docs/community.aws.ec2_placement_group_info_module.rst +++ b/docs/community.aws.ec2_placement_group_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +175,7 @@ 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
@@ -209,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -231,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -243,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 eda2dffdb8e..8c9186c2349 100644 --- a/docs/community.aws.ec2_placement_group_module.rst +++ b/docs/community.aws.ec2_placement_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -267,7 +267,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -279,9 +279,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 a5a0ac17605..76dab5ffd11 100644 --- a/docs/community.aws.ec2_scaling_policy_module.rst +++ b/docs/community.aws.ec2_scaling_policy_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -91,7 +90,7 @@ Parameters -
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.
+
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
@@ -110,7 +109,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -143,7 +142,7 @@ Parameters -
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.
+
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
@@ -196,7 +195,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -299,6 +298,7 @@ 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
@@ -350,7 +350,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -461,7 +461,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -473,9 +473,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9f93e140860..f3f55ee91e5 100644 --- a/docs/community.aws.ec2_snapshot_copy_module.rst +++ b/docs/community.aws.ec2_snapshot_copy_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -207,6 +207,7 @@ 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
@@ -240,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -309,7 +310,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -356,9 +357,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 27c90dc71ac..052da82c68b 100644 --- a/docs/community.aws.ec2_transit_gateway_info_module.rst +++ b/docs/community.aws.ec2_transit_gateway_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -173,6 +174,7 @@ 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
@@ -206,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 18f76c66a2d..669edfae9bb 100644 --- a/docs/community.aws.ec2_transit_gateway_module.rst +++ b/docs/community.aws.ec2_transit_gateway_module.rst @@ -27,9 +27,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -128,7 +129,7 @@ Parameters -
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.
+
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
@@ -147,7 +148,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -180,7 +181,7 @@ Parameters -
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.
+
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
@@ -251,7 +252,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -267,6 +268,7 @@ 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
@@ -319,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -391,7 +393,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -457,9 +459,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 4043cf775d6..6d309eab2b7 100644 --- a/docs/community.aws.ec2_vpc_egress_igw_module.rst +++ b/docs/community.aws.ec2_vpc_egress_igw_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +157,7 @@ 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
@@ -191,7 +191,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -232,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -260,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e690d470631..2a433f70523 100644 --- a/docs/community.aws.ec2_vpc_nacl_info_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,6 +193,7 @@ 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
@@ -226,7 +227,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -248,7 +249,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +262,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_module.rst b/docs/community.aws.ec2_vpc_nacl_module.rst index 329f218f0bc..d935d3377be 100644 --- a/docs/community.aws.ec2_vpc_nacl_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -224,6 +226,7 @@ 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
@@ -257,7 +260,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -332,7 +335,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -360,9 +363,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f6183111a62..c59ff562990 100644 --- a/docs/community.aws.ec2_vpc_peer_module.rst +++ b/docs/community.aws.ec2_vpc_peer_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -218,31 +220,12 @@ 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
- - -
- purge_tags - -
- boolean -
-
added in 2.0.0
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Remove tags not listed in tags.
- -
@@ -271,7 +254,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -329,7 +312,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -375,9 +358,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c23282c99b1..64d7086b0f2 100644 --- a/docs/community.aws.ec2_vpc_peering_info_module.rst +++ b/docs/community.aws.ec2_vpc_peering_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +246,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 59976e4a317..18265c7b2fe 100644 --- a/docs/community.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +241,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0468df68e68..b083c49731f 100644 --- a/docs/community.aws.ec2_vpc_route_table_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -177,6 +176,7 @@ 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
@@ -316,7 +316,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -389,7 +389,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -417,9 +417,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 307b0fa3046..a61eb76c01b 100644 --- a/docs/community.aws.ec2_vpc_vgw_info_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5da685210ba..b6654ad119f 100644 --- a/docs/community.aws.ec2_vpc_vgw_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -71,7 +71,7 @@ Parameters -
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.
+
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
@@ -90,7 +90,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +123,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -224,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -300,7 +301,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -358,9 +359,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 be6c5130e75..b182e0279ba 100644 --- a/docs/community.aws.ec2_vpc_vpn_info_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -207,7 +208,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +230,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +258,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b6dd8e5e6cb..b6fca122c45 100644 --- a/docs/community.aws.ec2_vpc_vpn_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -190,7 +191,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -382,6 +383,7 @@ 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
@@ -469,7 +471,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -593,7 +595,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -651,9 +653,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ddba8b42e43..4e3aca0c7af 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -26,11 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto - cryptography -- python >= 3.6 +- python >= 2.6 Parameters @@ -56,7 +54,7 @@ Parameters -
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.
+
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
@@ -75,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +106,7 @@ Parameters -
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.
+
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
@@ -145,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -224,6 +222,7 @@ 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
@@ -257,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -279,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +326,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5948d4227bc..6c9dc4f6e64 100644 --- a/docs/community.aws.ecs_attribute_module.rst +++ b/docs/community.aws.ecs_attribute_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -104,7 +105,7 @@ Parameters -
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.
+
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
@@ -123,7 +124,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -156,7 +157,7 @@ Parameters -
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.
+
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
@@ -225,7 +226,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -241,6 +242,7 @@ 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
@@ -274,7 +276,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -315,7 +317,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -327,9 +329,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_cluster_module.rst b/docs/community.aws.ecs_cluster_module.rst index d7f56836de7..c198e3fcba4 100644 --- a/docs/community.aws.ecs_cluster_module.rst +++ b/docs/community.aws.ecs_cluster_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -239,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -296,9 +297,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 8227a7a7e0e..853e153ab9d 100644 --- a/docs/community.aws.ecs_ecr_module.rst +++ b/docs/community.aws.ecs_ecr_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -242,6 +242,7 @@ 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
@@ -339,6 +340,7 @@ Parameters
if true, images are scanned for known vulnerabilities after being pushed to the repository.
+
scan_on_push requires botocore >= 1.13.3
@@ -353,7 +355,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -394,7 +396,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -406,9 +408,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 39b3f073f96..4d60e6d3480 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -26,9 +26,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -54,7 +56,7 @@ Parameters -
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.
+
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
@@ -73,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +108,7 @@ Parameters -
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.
+
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
@@ -177,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +214,7 @@ 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
@@ -245,7 +248,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +286,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -295,9 +298,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_module.rst b/docs/community.aws.ecs_service_module.rst index dc0663aaa06..d510fe56790 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -253,7 +255,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -289,6 +291,7 @@ Parameters
Seconds to wait before health checking the freshly added/updated services.
+
This option requires botocore >= 1.8.20.
@@ -355,6 +358,7 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+
assign_public_ip requires botocore >= 1.8.4
@@ -375,6 +379,7 @@ Parameters
Whether the task's elastic network interface receives a public IP address.
+
This option requires botocore >= 1.8.4.
@@ -540,6 +545,7 @@ 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
@@ -625,7 +631,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -749,7 +755,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -764,9 +770,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index d3b69c383ea..bbd6c2f793f 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +176,7 @@ 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
@@ -266,7 +268,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -323,7 +325,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -336,9 +338,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5847ab1df45..128ef7f6971 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -189,7 +191,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -225,6 +227,7 @@ Parameters
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+
assign_public_ip requires botocore >= 1.8.4
@@ -334,6 +337,7 @@ 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
@@ -367,7 +371,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -449,7 +453,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -461,9 +465,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_info_module.rst b/docs/community.aws.ecs_taskdefinition_info_module.rst index efb12e4debf..01f268e4ac5 100644 --- a/docs/community.aws.ecs_taskdefinition_info_module.rst +++ b/docs/community.aws.ecs_taskdefinition_info_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- json +- python >= 2.6 Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -142,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -158,6 +160,7 @@ 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
@@ -191,7 +194,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -243,9 +246,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9de5fcbc0e3..0132cbad123 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -25,12 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. +- boto - boto3 -- boto3 >= 1.15.0 - botocore -- botocore >= 1.18.0 - json -- python >= 3.6 +- python >= 2.6 Parameters @@ -71,7 +70,7 @@ Parameters -
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.
+
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
@@ -90,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +122,7 @@ Parameters -
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.
+
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
@@ -613,7 +612,7 @@ Parameters linuxParameters
- dictionary + list
@@ -1585,23 +1584,6 @@ Parameters
-
    Choices: -
  • core
    • -
  • cpu
    • -
  • data
    • -
  • fsize
    • -
  • locks
    • -
  • memlock
    • -
  • msgqueue
    • -
  • nice
    • -
  • nofile
    • -
  • nproc
    • -
  • rss
    • -
  • rtprio
    • -
  • rttime
    • -
  • sigpending
    • -
  • stack
    • -
The type of the ulimit.
@@ -1763,7 +1745,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -1888,6 +1870,7 @@ 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
@@ -1936,7 +1919,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1993,7 +1976,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -2039,9 +2022,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -2202,4 +2184,3 @@ Authors ~~~~~~~ - Mark Chance (@Java1Guy) -- Alina Buzachis (@alinabuzachis) diff --git a/docs/community.aws.efs_info_module.rst b/docs/community.aws.efs_info_module.rst index ebe311c9ec4..ab8ebd81da8 100644 --- a/docs/community.aws.efs_info_module.rst +++ b/docs/community.aws.efs_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -223,7 +224,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -277,7 +278,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -289,9 +290,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -531,7 +531,7 @@ Common return values are documented `here float
- when throughput_mode is set to "provisioned" + when botocore >= 1.10.57 and throughput_mode is set to "provisioned"
throughput provisioned in Mibps

@@ -582,7 +582,7 @@ Common return values are documented `here string
- always + when botocore >= 1.10.57
mode of throughput for the file system

diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 60d6071897c..06279ae5a2b 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -241,6 +241,7 @@ 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
@@ -259,6 +260,7 @@ Parameters
If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
+
Requires botocore >= 1.10.57
@@ -308,7 +310,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -432,6 +434,7 @@ Parameters
The throughput_mode for the file system to be created.
+
Requires botocore >= 1.10.57
@@ -450,7 +453,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -497,9 +500,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 775b3d36441..34254514c00 100644 --- a/docs/community.aws.elasticache_info_module.rst +++ b/docs/community.aws.elasticache_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +229,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +241,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 eb3c8e43697..0466cff2964 100644 --- a/docs/community.aws.elasticache_module.rst +++ b/docs/community.aws.elasticache_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -222,7 +222,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -324,6 +324,7 @@ 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
@@ -373,7 +374,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -417,7 +418,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -463,9 +464,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3f93a6865e5..d7554eb5d56 100644 --- a/docs/community.aws.elasticache_parameter_group_module.rst +++ b/docs/community.aws.elasticache_parameter_group_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -158,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -214,6 +215,7 @@ 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
@@ -247,7 +249,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -290,7 +292,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -317,9 +319,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 28218326b5e..73ccdec22d3 100644 --- a/docs/community.aws.elasticache_snapshot_module.rst +++ b/docs/community.aws.elasticache_snapshot_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -173,7 +174,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -253,7 +255,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -311,7 +313,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -323,9 +325,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 260f6a84026..cedd9859da5 100644 --- a/docs/community.aws.elasticache_subnet_group_module.rst +++ b/docs/community.aws.elasticache_subnet_group_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates, modifies, and deletes ElastiCache subnet groups. +- Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,8 +141,7 @@ Parameters -
ElastiCache subnet group description.
-
When not provided defaults to name on subnet group creation.
+
ElastiCache subnet group description. Only set when a new group is added.
@@ -158,7 +156,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,7 +174,6 @@ Parameters
Database subnet group identifier.
-
This value is automatically converted to lowercase.
@@ -191,6 +188,7 @@ 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
@@ -224,7 +222,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -237,11 +235,12 @@ Parameters
string + / required
    Choices: -
  • present ←
    • +
  • present
  • absent
@@ -263,7 +262,6 @@ Parameters
List of subnet IDs that make up the ElastiCache subnet group.
-
At least one subnet must be provided when creating an ElastiCache subnet group.
@@ -282,7 +280,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +292,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -321,128 +318,6 @@ Examples -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- cache_subnet_group - -
- dictionary -
- 		always -
Description of the Elasticache Subnet Group.
-
-
  -
- arn - -
- string -
- 		when the subnet group exists -
The Amazon Resource Name (ARN) of the cache subnet group.
-
-
Sample:
-
arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue
-
  -
- description - -
- string -
- 		when the cache subnet group exists -
The description of the cache subnet group.
-
-
Sample:
-
My Fancy Ex Parrot Subnet Group
-
  -
- name - -
- string -
- 		when the cache subnet group exists -
The name of the cache subnet group.
-
-
Sample:
-
norwegian-blue
-
  -
- subnet_ids - -
- list - / elements=string -
- 		when the cache subnet group exists -
The IDs of the subnets beloging to the cache subnet group.
-
-
Sample:
-
['subnet-aaaaaaaa', 'subnet-bbbbbbbb']
-
  -
- vpc_id - -
- string -
- 		when the cache subnet group exists -
The VPC ID of the cache subnet group.
-
-
Sample:
-
norwegian-blue
-
-

- Status ------ diff --git a/docs/community.aws.elb_application_lb_info_module.rst b/docs/community.aws.elb_application_lb_info_module.rst index d511a3ddc24..ef71064e90b 100644 --- a/docs/community.aws.elb_application_lb_info_module.rst +++ b/docs/community.aws.elb_application_lb_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -224,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -332,7 +332,7 @@ Common return values are documented `here string
- + when status is present
The name of the S3 bucket for the access logs.

@@ -350,7 +350,7 @@ Common return values are documented `here string - + when status is present
Indicates whether access logs stored in Amazon S3 are enabled.

@@ -368,7 +368,7 @@ Common return values are documented `here string - + when status is present
The prefix for the location in the S3 bucket.

@@ -386,7 +386,7 @@ Common return values are documented `here list - + when status is present
The Availability Zones for the load balancer.

@@ -404,7 +404,7 @@ Common return values are documented `here string - + when status is present
The ID of the Amazon Route 53 hosted zone associated with the load balancer.

@@ -422,7 +422,7 @@ Common return values are documented `here string - + when status is present
The date and time the load balancer was created.

@@ -440,7 +440,7 @@ Common return values are documented `here string - + when status is present
Indicates whether deletion protection is enabled.

@@ -458,7 +458,7 @@ Common return values are documented `here string - + when status is present
The public DNS name of the load balancer.

@@ -476,7 +476,7 @@ Common return values are documented `here string - + when status is present
The idle timeout value, in seconds.

@@ -494,7 +494,7 @@ Common return values are documented `here string - + when status is present
The type of IP addresses used by the subnets for the load balancer.

@@ -512,7 +512,7 @@ Common return values are documented `here string - + when status is present
The Amazon Resource Name (ARN) of the load balancer.

@@ -530,7 +530,7 @@ Common return values are documented `here string - + when status is present
The name of the load balancer.

@@ -548,7 +548,7 @@ Common return values are documented `here string - + when status is present
Internet-facing or internal load balancer.

@@ -566,7 +566,7 @@ Common return values are documented `here list - + when status is present
The IDs of the security groups for the load balancer.

@@ -584,7 +584,7 @@ Common return values are documented `here dictionary - + when status is present
The state of the load balancer.

@@ -602,7 +602,7 @@ Common return values are documented `here dictionary - + when status is present
The tags attached to the load balancer.

@@ -620,7 +620,7 @@ Common return values are documented `here string - + when status is present
The type of load balancer.

@@ -638,7 +638,7 @@ Common return values are documented `here string - + when status is present
The ID of the VPC for the load balancer.

diff --git a/docs/community.aws.elb_application_lb_module.rst b/docs/community.aws.elb_application_lb_module.rst index 020d3b34212..cae74399a5d 100644 --- a/docs/community.aws.elb_application_lb_module.rst +++ b/docs/community.aws.elb_application_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -127,7 +127,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -160,7 +160,7 @@ Parameters -
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.
+
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
@@ -217,7 +217,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -256,25 +256,6 @@ Parameters
The number of seconds to wait before an idle connection is closed.
- - -
- ip_address_type - -
- string -
- - -
    Choices: -
  • ipv4
    • -
  • dualstack
    • -
- - -
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
- -
@@ -529,6 +510,7 @@ 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
@@ -658,7 +640,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -731,7 +713,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -779,9 +761,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 fcc2bc01b6b..a6a90f89ee5 100644 --- a/docs/community.aws.elb_classic_lb_info_module.rst +++ b/docs/community.aws.elb_classic_lb_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -175,6 +176,7 @@ 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
@@ -208,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -230,7 +232,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -242,9 +244,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 new file mode 100644 index 00000000000..85612a0453c --- /dev/null +++ b/docs/community.aws.elb_classic_lb_module.rst @@ -0,0 +1,843 @@ +.. _community.aws.elb_classic_lb_module: + + +**************************** +community.aws.elb_classic_lb +**************************** + +**Creates or destroys Amazon ELB.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Returns information about the load balancer. +- Will be marked changed when called only if state is changed. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 2.6 +- boto + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access_logs + +
+ dictionary +
+ 		+ +
An associative array of access logs configuration settings (see example).
+
+
+ aws_access_key + +
+ string +
+ 		+ +
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_ca_bundle + +
+ path +
+ 		+ +
The location of a CA Bundle to use when validating SSL certificates.
+
Only used for boto3 based modules.
+
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+
+
+ aws_config + +
+ dictionary +
+ 		+ +
A dictionary to modify the botocore configuration.
+ +
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+
+
+ aws_secret_key + +
+ string +
+ 		+ +
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
+
+
+ connection_draining_timeout + +
+ integer +
+ 		+ +
Wait a specified timeout allowing connections to drain before terminating an instance.
+
+
+ cross_az_load_balancing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distribute load across all configured Availability Zones.
+
Defaults to false.
+
+
+ debug_botocore_endpoint_logs + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+
+
+ ec2_url + +
+ string +
+ 		+ +
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
+
+
+ health_check + +
+ dictionary +
+ 		+ +
An associative array of health check configuration settings (see example).
+
+
+ idle_timeout + +
+ integer +
+ 		+ +
ELB connections from clients and to servers are timed out after this amount of time.
+
+
+ instance_ids + +
+ list + / elements=string +
+ 		+ +
List of instance ids to attach to this ELB.
+
+
+ listeners + +
+ list + / elements=dictionary +
+ 		+ +
List of ports/protocols for this ELB to listen on (see example).
+
+
+ name + +
+ string + / required +
+ 		+ +
The name of the ELB.
+
+
+ profile + +
+ 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
+
+
+ purge_instance_ids + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing instance ids on ELB that are not found in instance_ids.
+
+
+ purge_listeners + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Purge existing listeners on ELB that are not found in listeners.
+
+
+ purge_subnets + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing subnets on ELB that are not found in subnets.
+
+
+ purge_zones + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing availability zones on ELB that are not found in zones.
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ scheme + +
+ string +
+ 		+
    Choices: +
  • internal
    • +
  • internet-facing ←
    • +
+ 		+
The scheme to use when creating the ELB.
+
For a private VPC-visible ELB use internal.
+
If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must set wait=true.
+
+
+ security_group_ids + +
+ list + / elements=string +
+ 		+ +
A list of security groups to apply to the ELB.
+
+
+ security_group_names + +
+ list + / elements=string +
+ 		+ +
A list of security group names to apply to the ELB.
+
+
+ security_token + +
+ 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
+
+
+ state + +
+ string + / required +
+ 		+
    Choices: +
  • present
    • +
  • absent
    • +
+ 		+
Create or destroy the ELB.
+
+
+ stickiness + +
+ dictionary +
+ 		+ +
An associative array of stickiness policy settings. Policy will be applied to all listeners (see example).
+
+
+ subnets + +
+ list + / elements=string +
+ 		+ +
A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
+
+
+ tags + +
+ dictionary +
+ 		+ +
An associative array of tags. To delete all tags, supply an empty dict.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to false, SSL certificates will not be validated for boto versions >= 2.6.0.
+
+
+ wait + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
+
+
+ wait_timeout + +
+ integer +
+ 		+ Default:
60
+ 		+
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated. A maximum of 600 seconds (10 minutes) is allowed.
+
+
+ zones + +
+ list + / elements=string +
+ 		+ +
List of availability zones to enable on this ELB.
+
+
+ + +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_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 + + + +Examples +-------- + +.. code-block:: yaml + + # Note: None of these examples set aws_access_key, aws_secret_key, or region. + # It is assumed that their matching environment variables are set. + + # Basic provisioning example (non-VPC) + + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + proxy_protocol: True + - protocol: https + load_balancer_port: 443 + instance_protocol: http # optional, defaults to value of protocol setting + instance_port: 80 + # ssl certificate required for https or ssl + ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert" + delegate_to: localhost + + # Internal ELB example + + - community.aws.elb_classic_lb: + name: "test-vpc" + scheme: internal + state: present + instance_ids: + - i-abcd1234 + purge_instance_ids: true + subnets: + - subnet-abcd1234 + - subnet-1a2b3c4d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Configure a health check and the access logs + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + health_check: + ping_protocol: http # options are http, https, ssl, tcp + ping_port: 80 + ping_path: "/index.html" # not required for tcp or ssl + response_timeout: 5 # seconds + interval: 30 # seconds + unhealthy_threshold: 2 + healthy_threshold: 10 + access_logs: + interval: 5 # minutes (defaults to 60) + s3_location: "my-bucket" # This value is required if access_logs is set + s3_prefix: "logs" + delegate_to: localhost + + # Ensure ELB is gone + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + delegate_to: localhost + + # Ensure ELB is gone and wait for check (for default timeout) + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + delegate_to: localhost + + # Ensure ELB is gone and wait for check with timeout value + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + wait_timeout: 600 + delegate_to: localhost + + # Normally, this module will purge any listeners that exist on the ELB + # but aren't specified in the listeners parameter. If purge_listeners is + # false it leaves them alone + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_listeners: no + delegate_to: localhost + + # Normally, this module will leave availability zones that are enabled + # on the ELB alone. If purge_zones is true, then any extraneous zones + # will be removed + - community.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_zones: yes + delegate_to: localhost + + # Creates a ELB and assigns a list of subnets to it. + - community.aws.elb_classic_lb: + state: present + name: 'New ELB' + security_group_ids: 'sg-123456, sg-67890' + region: us-west-2 + subnets: 'subnet-123456,subnet-67890' + purge_subnets: yes + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Create an ELB with connection draining, increased idle timeout and cross availability + # zone load balancing + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + connection_draining_timeout: 60 + idle_timeout: 300 + cross_az_load_balancing: "yes" + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + delegate_to: localhost + + # Create an ELB with load balancer stickiness enabled + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: loadbalancer + enabled: yes + expiration: 300 + delegate_to: localhost + + # Create an ELB with application stickiness enabled + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: application + enabled: yes + cookie: SESSIONID + delegate_to: localhost + + # Create an ELB and add tags + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: + Name: "New ELB" + stack: "production" + client: "Bob" + delegate_to: localhost + + # Delete all tags from an ELB + - community.aws.elb_classic_lb: + name: "New ELB" + state: present + region: us-east-1 + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: {} + delegate_to: localhost + + + + +Status +------ + + +Authors +~~~~~~~ + +- Jim Dalton (@jsdalton) diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index 00248cbdebb..be68b327065 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -27,10 +27,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -56,7 +54,7 @@ Parameters -
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.
+
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
@@ -75,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +106,7 @@ Parameters -
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.
+
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
@@ -146,8 +144,7 @@ Parameters -
List of ELB names, required for registration.
-
The ec2_elbs fact should be used if there was a previous de-register.
+
List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
@@ -162,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -182,8 +179,7 @@ Parameters -
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled.
-
If enable_availability_zone=no, the task will fail if the availability zone is not enabled on the ELB.
+
Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
@@ -214,6 +210,7 @@ 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
@@ -247,7 +244,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -270,7 +267,7 @@ Parameters -
Register or deregister the instance.
+
register or deregister the instance
@@ -289,7 +286,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -324,10 +321,7 @@ Parameters Default:
0
-
Number of seconds to wait for an instance to change state.
-
If wait_timeout=0 then this module may return an error if a transient error occurs.
-
If non-zero then any transient errors are ignored until the timeout is reached.
-
Ignored when wait=no.
+
Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
@@ -339,9 +333,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 fee52ab88f8..79895efaac0 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -182,29 +182,10 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
- - -
- ip_address_type - -
- string -
- - -
    Choices: -
  • ipv4
    • -
  • dualstack
    • -
- - -
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
- -
@@ -388,6 +369,7 @@ 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
@@ -480,7 +462,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -572,7 +554,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -620,9 +602,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3d300df03d3..4ee35257c3c 100644 --- a/docs/community.aws.elb_target_group_info_module.rst +++ b/docs/community.aws.elb_target_group_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -162,7 +162,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -209,6 +209,7 @@ 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
@@ -242,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -280,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -292,9 +293,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 9995592049d..7549b81d275 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -329,6 +329,7 @@ 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
@@ -410,7 +411,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -619,7 +620,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -682,9 +683,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 39b55cf4a69..53d29e3295c 100644 --- a/docs/community.aws.elb_target_info_module.rst +++ b/docs/community.aws.elb_target_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -194,6 +195,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 450e470048f..f596429753d 100644 --- a/docs/community.aws.elb_target_module.rst +++ b/docs/community.aws.elb_target_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -162,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -178,6 +177,7 @@ 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
@@ -211,7 +211,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -371,7 +371,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -384,9 +384,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 5f6f70fd960..4e9b5d6f4a2 100644 --- a/docs/community.aws.execute_lambda_module.rst +++ b/docs/community.aws.execute_lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -161,7 +161,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -297,7 +298,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -345,9 +346,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 7363b72fa27..52d02622b65 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_cert_module.rst @@ -25,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -54,7 +52,7 @@ Parameters -
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.
+
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
@@ -73,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +104,7 @@ Parameters -
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.
+
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
@@ -194,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -289,6 +287,7 @@ 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
@@ -322,7 +321,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -365,7 +364,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -377,9 +376,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 90c97b2c894..2eb85c16334 100644 --- a/docs/community.aws.iam_group_module.rst +++ b/docs/community.aws.iam_group_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +193,7 @@ 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
@@ -264,7 +266,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -322,7 +324,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -334,9 +336,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d5f9878f4a3..56ed8f76cd9 100644 --- a/docs/community.aws.iam_managed_policy_module.rst +++ b/docs/community.aws.iam_managed_policy_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -262,6 +263,7 @@ 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
@@ -295,7 +297,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -336,7 +338,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -348,9 +350,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2d679b95a89..b76f802ef87 100644 --- a/docs/community.aws.iam_mfa_device_info_module.rst +++ b/docs/community.aws.iam_mfa_device_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -159,6 +160,7 @@ 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
@@ -192,7 +194,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 971d5afdcb3..be1e539d5d2 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -14,13 +14,6 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The iam module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`iam_user `, :ref:`iam_group `, :ref:`iam_role `, :ref:`iam_policy ` and :ref:`iam_managed_policy ` modules. - - Synopsis -------- @@ -32,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -102,7 +93,7 @@ Parameters -
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.
+
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
@@ -121,7 +112,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -154,7 +145,7 @@ Parameters -
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.
+
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
@@ -191,7 +182,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -339,6 +330,7 @@ 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
@@ -372,7 +364,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -468,7 +460,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -481,9 +473,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -594,10 +585,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.iam_password_policy_module.rst b/docs/community.aws.iam_password_policy_module.rst index 593be87d97f..e1bdb8ce9fe 100644 --- a/docs/community.aws.iam_password_policy_module.rst +++ b/docs/community.aws.iam_password_policy_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -73,7 +74,7 @@ Parameters -
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.
+
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
@@ -92,7 +93,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -125,7 +126,7 @@ Parameters -
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.
+
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
@@ -162,7 +163,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -195,6 +196,7 @@ 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
@@ -358,7 +360,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -400,7 +402,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -412,9 +414,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1c3361febd1..6d06db1d93f 100644 --- a/docs/community.aws.iam_policy_info_module.rst +++ b/docs/community.aws.iam_policy_info_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -210,6 +209,7 @@ 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
@@ -243,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -265,7 +265,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -277,9 +277,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e5fc98f019e..f976ac1a4d0 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -143,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -246,6 +245,7 @@ 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
@@ -279,7 +279,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -340,7 +340,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -352,9 +352,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d7de4a0837d..2e3abc9fe1e 100644 --- a/docs/community.aws.iam_role_info_module.rst +++ b/docs/community.aws.iam_role_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +192,7 @@ 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
@@ -225,7 +226,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -247,7 +248,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -259,9 +260,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b2f8568bf43..e81541d815a 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -69,7 +70,7 @@ Parameters -
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.
+
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
@@ -88,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +122,7 @@ Parameters -
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.
+
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
@@ -143,6 +144,7 @@ Parameters
Boundaries cannot be set on Instance Profiles, as such if this option is specified then create_instance_profile must be false.
This is intended for roles/users that have permissions to create new IAM objects.
+
Requires botocore 1.10.57 or above.

aliases: boundary_policy_arn
@@ -231,7 +233,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -314,6 +316,7 @@ 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
@@ -387,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -425,6 +428,7 @@ Parameters
Tag dict to apply to the queue.
+
Requires botocore 1.12.46 or above.
@@ -443,7 +447,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -455,9 +459,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 785b1509c4b..3e9ac69b646 100644 --- a/docs/community.aws.iam_saml_federation_module.rst +++ b/docs/community.aws.iam_saml_federation_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +174,7 @@ 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
@@ -222,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -263,7 +264,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -275,9 +276,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1f81ea21f74..c41d2407cb4 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -143,7 +144,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -207,7 +209,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -229,7 +231,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -241,9 +243,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 1ad22f8cc81..f33064c0dd6 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -205,6 +206,7 @@ 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
@@ -238,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -260,7 +262,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -272,9 +274,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 806451fa983..de70f8358d3 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -192,6 +193,7 @@ 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
@@ -245,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -287,7 +289,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -299,9 +301,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 51ed5640cb0..27b71b0b487 100644 --- a/docs/community.aws.kinesis_stream_module.rst +++ b/docs/community.aws.kinesis_stream_module.rst @@ -28,9 +28,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -56,7 +56,7 @@ Parameters -
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.
+
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
@@ -75,7 +75,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -108,7 +108,7 @@ Parameters -
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.
+
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
@@ -145,7 +145,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -231,6 +231,7 @@ 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
@@ -282,7 +283,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -355,7 +356,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -402,9 +403,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6d0acd53328..c50bf63db31 100644 --- a/docs/community.aws.lambda_alias_module.rst +++ b/docs/community.aws.lambda_alias_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -222,6 +222,7 @@ 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
@@ -255,7 +256,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -296,7 +297,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -308,9 +309,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 14c0f6d008c..9d10ac318e9 100644 --- a/docs/community.aws.lambda_event_module.rst +++ b/docs/community.aws.lambda_event_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -69,7 +69,7 @@ Parameters -
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.
+
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
@@ -88,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +121,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -212,6 +212,7 @@ 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
@@ -245,7 +246,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -379,7 +380,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -407,9 +408,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 417f3d17179..369bd9399be 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -32,9 +32,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -60,7 +60,7 @@ Parameters -
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.
+
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
@@ -79,7 +79,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -112,7 +112,7 @@ Parameters -
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.
+
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
@@ -149,7 +149,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -196,6 +196,7 @@ 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
@@ -252,7 +253,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -274,7 +275,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -286,9 +287,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2f08ea7159b..ce265e7087d 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -143,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +190,7 @@ 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
@@ -246,7 +247,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -268,7 +269,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -280,9 +281,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 682891507e9..7368c05fed4 100644 --- a/docs/community.aws.lambda_module.rst +++ b/docs/community.aws.lambda_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -172,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -250,6 +250,7 @@ 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
@@ -365,7 +366,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -402,7 +403,7 @@ Parameters -
Tag dict to apply to the function.
+
tag dict to apply to the function (requires botocore 1.5.40 or above).
@@ -456,7 +457,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -520,9 +521,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 ca1dd8a9309..6b9fdbf943b 100644 --- a/docs/community.aws.lambda_policy_module.rst +++ b/docs/community.aws.lambda_policy_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -86,7 +86,7 @@ Parameters -
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.
+
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
@@ -105,7 +105,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -138,7 +138,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +243,7 @@ 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
@@ -276,7 +277,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -364,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -391,9 +392,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 441529b5378..5ff6b603b43 100644 --- a/docs/community.aws.lightsail_module.rst +++ b/docs/community.aws.lightsail_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -223,6 +223,7 @@ 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
@@ -256,7 +257,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -317,7 +318,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -382,9 +383,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 530ac744f26..3e199320cb1 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 +- python >= 2.7 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +191,7 @@ 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
@@ -223,7 +225,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -245,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -257,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2bb3a389893..e679974045b 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.5.0 +- botocore +- python >= 2.6 Parameters @@ -141,7 +142,7 @@ Parameters -
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.
+
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
@@ -160,7 +161,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -193,7 +194,7 @@ Parameters -
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.
+
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
@@ -472,7 +473,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -927,6 +928,7 @@ 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
@@ -1134,7 +1136,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -1401,7 +1403,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -1448,9 +1450,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 76da476f977..c3391656668 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -14,20 +14,14 @@ Version added: 1.0.0 :local: :depth: 1 -DEPRECATED ----------- -:Removed in collection release after -:Why: The rds module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`rds_instance `, :ref:`rds_instance_info `, and :ref:`rds_snapshot `. - - Synopsis -------- - Creates, deletes, or modifies rds resources. - When creating an instance it can be either a new instance or a read-only replica of an existing instance. +- This module has a dependency on python-boto >= 2.5 and will soon be deprecated. - The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0). -- Please use the boto3 based :ref:`community.aws.rds_instance ` instead. +- Please use boto3 based :ref:`community.aws.rds_instance ` instead. @@ -35,10 +29,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -84,7 +76,7 @@ Parameters -
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.
+
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
@@ -103,7 +95,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -136,7 +128,7 @@ Parameters -
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.
+
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
@@ -301,7 +293,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -550,6 +542,7 @@ 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
@@ -616,7 +609,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -758,7 +751,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -843,9 +836,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -1707,10 +1699,6 @@ Status ------ -- This module will be removed in version 3.0.0. *[deprecated]* -- For more information see `DEPRECATED`_. - - Authors ~~~~~~~ diff --git a/docs/community.aws.rds_param_group_module.rst b/docs/community.aws.rds_param_group_module.rst index 9715206d56c..9905c5a88d8 100644 --- a/docs/community.aws.rds_param_group_module.rst +++ b/docs/community.aws.rds_param_group_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -157,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +243,7 @@ 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
@@ -295,7 +296,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -352,7 +353,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -364,9 +365,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 7e5c169f9fe..8835ebf4347 100644 --- a/docs/community.aws.rds_snapshot_info_module.rst +++ b/docs/community.aws.rds_snapshot_info_module.rst @@ -27,9 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -55,7 +55,7 @@ Parameters -
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.
+
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
@@ -74,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +107,7 @@ Parameters -
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.
+
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
@@ -209,7 +209,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -225,6 +225,7 @@ 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
@@ -258,7 +259,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -302,7 +303,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -314,9 +315,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 657b56b7165..95ec276a159 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_snapshot_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -175,7 +175,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -191,6 +191,7 @@ 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
@@ -243,7 +244,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -299,7 +300,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -346,9 +347,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 2618eb29a14..3b624ccdb09 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -190,6 +189,7 @@ 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
@@ -223,7 +223,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -282,7 +282,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -294,9 +294,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 10e633cb2e0..f1ad74a43b6 100644 --- a/docs/community.aws.redshift_cross_region_snapshots_module.rst +++ b/docs/community.aws.redshift_cross_region_snapshots_module.rst @@ -26,9 +26,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -54,7 +55,7 @@ Parameters -
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.
+
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
@@ -73,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +107,7 @@ Parameters -
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.
+
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
@@ -177,7 +178,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -193,6 +194,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -302,7 +304,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -314,9 +316,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6535817f66c..4d8230f0ea6 100644 --- a/docs/community.aws.redshift_info_module.rst +++ b/docs/community.aws.redshift_info_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -160,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -176,6 +176,7 @@ 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
@@ -209,7 +210,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -246,7 +247,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -258,9 +259,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 c5bd313bacc..27742aa8b82 100644 --- a/docs/community.aws.redshift_module.rst +++ b/docs/community.aws.redshift_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -124,7 +124,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -157,7 +157,7 @@ Parameters -
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.
+
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
@@ -318,7 +318,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -531,6 +531,7 @@ 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
@@ -603,7 +604,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -679,7 +680,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -744,9 +745,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 b007c1e9934..7f66c0334a7 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -25,10 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- boto +- python >= 2.6 Parameters @@ -54,7 +52,7 @@ Parameters -
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.
+
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
@@ -73,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +104,7 @@ Parameters -
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.
+
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
@@ -143,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -160,7 +158,6 @@ Parameters
Database subnet group description.
-
Required when state=present.

aliases: description
@@ -195,7 +192,6 @@ Parameters
List of subnet IDs that make up the cluster subnet group.
-
Required when state=present.

aliases: subnets
@@ -211,6 +207,7 @@ 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
@@ -244,7 +241,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -286,7 +283,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -298,9 +295,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 3d29ebeb929..b4b25fada6b 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -26,10 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 3.6 +- python >= 2.6 +- boto Parameters @@ -55,7 +53,7 @@ Parameters -
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.
+
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
@@ -74,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -107,7 +105,7 @@ Parameters -
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.
+
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
@@ -144,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -232,6 +230,7 @@ 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
@@ -302,7 +301,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -381,7 +380,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -393,9 +392,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 d81b24597e5..e44d3e25ed0 100644 --- a/docs/community.aws.route53_info_module.rst +++ b/docs/community.aws.route53_info_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -190,7 +189,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -314,6 +313,7 @@ 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
@@ -390,7 +390,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -454,7 +454,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -466,9 +466,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 47e58e06062..8c08e3bff64 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -108,7 +109,7 @@ Parameters -
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.
+
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
@@ -127,7 +128,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -160,7 +161,7 @@ Parameters -
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.
+
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
@@ -197,7 +198,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -318,6 +319,7 @@ 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
@@ -383,7 +385,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -475,7 +477,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -587,9 +589,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 f80f0e2a9ac..0af97d45d8f 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -174,7 +174,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -206,6 +206,7 @@ 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
@@ -239,7 +240,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -280,7 +281,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -338,9 +339,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0f62c6e343b..a801b0ded68 100644 --- a/docs/community.aws.s3_bucket_notification_module.rst +++ b/docs/community.aws.s3_bucket_notification_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -158,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -283,6 +283,7 @@ 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
@@ -316,7 +317,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -372,7 +373,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -385,9 +386,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 6a940862780..6382c26d25c 100644 --- a/docs/community.aws.s3_lifecycle_module.rst +++ b/docs/community.aws.s3_lifecycle_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -291,6 +290,7 @@ 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
@@ -380,7 +380,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -513,7 +513,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -547,9 +547,8 @@ Notes - 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 67762810882..cba4b51503d 100644 --- a/docs/community.aws.s3_logging_module.rst +++ b/docs/community.aws.s3_logging_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -142,7 +141,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +173,7 @@ 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
@@ -207,7 +207,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -279,7 +279,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -291,9 +291,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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_metrics_configuration_module.rst b/docs/community.aws.s3_metrics_configuration_module.rst index 449fd5d9b1f..570d88bd6f3 100644 --- a/docs/community.aws.s3_metrics_configuration_module.rst +++ b/docs/community.aws.s3_metrics_configuration_module.rst @@ -25,9 +25,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- python >= 2.6 +- boto Parameters @@ -53,7 +52,7 @@ Parameters -
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.
+
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
@@ -72,7 +71,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +104,7 @@ Parameters -
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.
+
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
@@ -158,7 +157,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -221,6 +220,7 @@ 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
@@ -254,7 +254,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +295,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -310,9 +310,8 @@ Notes - To request metrics for the entire bucket, create a metrics configuration without a filter - Metrics configurations are necessary only to enable request metric, bucket-level daily storage metrics are always turned on - If parameters 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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 348639b2c2e..bc674a64e25 100644 --- a/docs/community.aws.s3_sync_module.rst +++ b/docs/community.aws.s3_sync_module.rst @@ -25,9 +25,11 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 >= 1.4.4 +- botocore +- python >= 2.6 +- python-dateutil Parameters @@ -53,7 +55,7 @@ Parameters -
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.
+
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
@@ -72,7 +74,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +107,7 @@ Parameters -
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.
+
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
@@ -193,7 +195,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -358,6 +360,7 @@ 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
@@ -406,7 +409,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -454,7 +457,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -466,9 +469,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 @@ -488,11 +490,6 @@ Examples file_root: roles/s3/files/ storage_class: GLACIER - - name: basic individual file upload - community.aws.s3_sync: - bucket: tedder - file_root: roles/s3/files/file_name - - name: all the options community.aws.s3_sync: bucket: tedder diff --git a/docs/community.aws.s3_website_module.rst b/docs/community.aws.s3_website_module.rst index 90078b3afc3..356cf0315ca 100644 --- a/docs/community.aws.s3_website_module.rst +++ b/docs/community.aws.s3_website_module.rst @@ -25,9 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -53,7 +53,7 @@ Parameters -
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.
+
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
@@ -72,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +105,7 @@ Parameters -
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.
+
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
@@ -142,7 +142,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +189,7 @@ 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
@@ -237,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -295,7 +296,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -307,9 +308,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 177cf3c3452..83d5165b902 100644 --- a/docs/community.aws.sns_module.rst +++ b/docs/community.aws.sns_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -68,7 +69,7 @@ Parameters -
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.
+
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
@@ -87,7 +88,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -120,7 +121,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -302,6 +303,7 @@ 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
@@ -335,7 +337,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -418,7 +420,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -430,9 +432,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 321a1b958ec..3cf7abcd32f 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -26,9 +26,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- python >= 2.6 Parameters @@ -54,7 +53,7 @@ Parameters -
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.
+
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
@@ -73,7 +72,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +105,7 @@ Parameters -
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.
+
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
@@ -173,7 +172,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -220,6 +219,7 @@ 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
@@ -272,7 +272,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -349,26 +349,6 @@ Parameters - - -
- topic_type - -
- string -
-
added in 2.0.0
- - -
    Choices: -
  • standard ←
    • -
  • fifo
    • -
- - -
The type of topic that should be created. Either Standard for FIFO (first-in, first-out)
- -
@@ -385,7 +365,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -397,9 +377,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 e32121739cb..341f9ca2fc2 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -26,9 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- python >= 2.6 Parameters @@ -54,7 +54,7 @@ Parameters -
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.
+
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
@@ -73,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -106,7 +106,7 @@ Parameters -
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.
+
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
@@ -179,7 +179,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -287,6 +287,7 @@ 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
@@ -390,7 +391,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -427,7 +428,7 @@ Parameters -
Tag dict to apply to the queue.
+
Tag dict to apply to the queue (requires botocore 1.5.40 or above).
To remove all tags set tags={} and purge_tags=true.
@@ -447,7 +448,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -475,9 +476,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 bfab5056a22..16b197c2bce 100644 --- a/docs/community.aws.sts_assume_role_module.rst +++ b/docs/community.aws.sts_assume_role_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -159,7 +160,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -235,6 +236,7 @@ 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
@@ -300,7 +302,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -322,7 +324,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -335,9 +337,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 0a9b8e9c3a5..26dae630d73 100644 --- a/docs/community.aws.sts_session_token_module.rst +++ b/docs/community.aws.sts_session_token_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -157,7 +158,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -203,6 +204,7 @@ 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
@@ -236,7 +238,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -258,7 +260,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -271,9 +273,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_ip_set_info_module.rst b/docs/community.aws.wafv2_ip_set_info_module.rst index 4f654bf6060..204f6619644 100644 --- a/docs/community.aws.wafv2_ip_set_info_module.rst +++ b/docs/community.aws.wafv2_ip_set_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_ip_set_module.rst b/docs/community.aws.wafv2_ip_set_module.rst index 506e1b2e1e2..cd08ee1d1fd 100644 --- a/docs/community.aws.wafv2_ip_set_module.rst +++ b/docs/community.aws.wafv2_ip_set_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -71,7 +72,7 @@ Parameters -
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.
+
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
@@ -90,7 +91,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -123,7 +124,7 @@ Parameters -
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.
+
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
@@ -175,7 +176,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -227,6 +228,7 @@ 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
@@ -299,7 +301,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -357,7 +359,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -369,9 +371,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_resources_info_module.rst b/docs/community.aws.wafv2_resources_info_module.rst index 934e20ed66a..3c11ea767b7 100644 --- a/docs/community.aws.wafv2_resources_info_module.rst +++ b/docs/community.aws.wafv2_resources_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_resources_module.rst b/docs/community.aws.wafv2_resources_module.rst index ab010c46476..5cce8c74359 100644 --- a/docs/community.aws.wafv2_resources_module.rst +++ b/docs/community.aws.wafv2_resources_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -69,7 +70,7 @@ Parameters -
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.
+
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
@@ -88,7 +89,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -121,7 +122,7 @@ Parameters -
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.
+
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
@@ -158,7 +159,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -189,6 +190,7 @@ 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
@@ -241,7 +243,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -283,7 +285,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -295,9 +297,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_rule_group_info_module.rst b/docs/community.aws.wafv2_rule_group_info_module.rst index 9af6fceb5db..9de423f1e64 100644 --- a/docs/community.aws.wafv2_rule_group_info_module.rst +++ b/docs/community.aws.wafv2_rule_group_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -269,7 +271,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -281,9 +283,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_rule_group_module.rst b/docs/community.aws.wafv2_rule_group_module.rst index 36094e45332..a158cbb7946 100644 --- a/docs/community.aws.wafv2_rule_group_module.rst +++ b/docs/community.aws.wafv2_rule_group_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -191,7 +192,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -239,6 +240,7 @@ 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
@@ -346,7 +348,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -403,7 +405,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -415,9 +417,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_web_acl_info_module.rst b/docs/community.aws.wafv2_web_acl_info_module.rst index 761b4b9fd2c..0e1c329f840 100644 --- a/docs/community.aws.wafv2_web_acl_info_module.rst +++ b/docs/community.aws.wafv2_web_acl_info_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -142,7 +143,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -174,6 +175,7 @@ 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
@@ -227,7 +229,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -249,7 +251,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -261,9 +263,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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.wafv2_web_acl_module.rst b/docs/community.aws.wafv2_web_acl_module.rst index 32324dcd9b2..a23a519e438 100644 --- a/docs/community.aws.wafv2_web_acl_module.rst +++ b/docs/community.aws.wafv2_web_acl_module.rst @@ -25,9 +25,10 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto +- boto3 +- botocore +- python >= 2.6 Parameters @@ -53,7 +54,7 @@ Parameters -
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.
+
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
@@ -72,7 +73,7 @@ Parameters
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
+
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
@@ -105,7 +106,7 @@ Parameters -
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.
+
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
@@ -195,7 +196,7 @@ Parameters -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
@@ -243,6 +244,7 @@ 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
@@ -431,7 +433,7 @@ Parameters -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
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
@@ -488,7 +490,7 @@ Parameters -
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -500,9 +502,8 @@ 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_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`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + - 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 52f221bf07a..92e1c2419b5 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 2.0.0 +version: 1.5.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: '>=2.0.0' + amazon.aws: '>=1.5.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/meta/runtime.yml b/meta/runtime.yml index c1ca9228a31..7572647d422 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -35,7 +35,6 @@ action_groups: - elb_target_group_facts - iam_mfa_device_facts - iam_role_facts - - iam_cert_facts - iam_server_certificate_facts - lambda_facts - rds_instance_facts @@ -172,7 +171,6 @@ action_groups: - iam_role - iam_role_info - iam_saml_federation - - iam_server_certificate - iam_server_certificate_info - iam_user - iam_user_info @@ -450,7 +448,7 @@ plugin_routing: deprecation: removal_date: 2021-12-01 warning_text: >- - iam_cert_facts was renamed in Ansible 2.9 to iam_server_certificate_info. + iam_cert_facts was renamed in Ansible 2.9 to iam_cert_info. Please update your tasks. iam_mfa_device_facts: deprecation: @@ -464,13 +462,6 @@ plugin_routing: warning_text: >- iam_role_facts was renamed in Ansible 2.9 to iam_role_info. Please update your tasks. - iam_cert: - redirect: community.aws.iam_server_certificate - deprecation: - removal_version: 4.0.0 - warning_text: >- - iam_cert has been renamed to iam_server_certificate for consistency. - Please update your tasks. iam_server_certificate_facts: deprecation: removal_date: 2021-12-01 diff --git a/plugins/modules/aws_msk_cluster.py b/plugins/modules/aws_msk_cluster.py index d6cf35d3ba3..41f2dd62e44 100644 --- a/plugins/modules/aws_msk_cluster.py +++ b/plugins/modules/aws_msk_cluster.py @@ -544,6 +544,7 @@ def create_or_update_cluster(client, module): } }, "cluster_kafka_version": { + "botocore_version": "1.16.19", "current_value": cluster["CurrentBrokerSoftwareInfo"]["KafkaVersion"], "target_value": module.params.get("version"), "update_params": { diff --git a/plugins/modules/aws_msk_config.py b/plugins/modules/aws_msk_config.py index f1966847422..6258ae916f6 100644 --- a/plugins/modules/aws_msk_config.py +++ b/plugins/modules/aws_msk_config.py @@ -279,6 +279,9 @@ def main(): module = AnsibleAWSModule(argument_spec=module_args, supports_check_mode=True) + # Support for update_configuration and delete_configuration added in 1.17.48 + module.require_botocore_at_least('1.17.48') + client = module.client("kafka", retry_decorator=AWSRetry.jittered_backoff()) if module.params["state"] == "present": diff --git a/plugins/modules/cloudfront_distribution.py b/plugins/modules/cloudfront_distribution.py index 80ac6dcec4b..9887a8d373a 100644 --- a/plugins/modules/cloudfront_distribution.py +++ b/plugins/modules/cloudfront_distribution.py @@ -1591,8 +1591,7 @@ def __init__(self, module): 'TLSv1_2016', 'TLSv1.1_2016', 'TLSv1.2_2018', - 'TLSv1.2_2019', - 'TLSv1.2_2021' + 'TLSv1.2_2019' ]) self.__valid_viewer_certificate_certificate_sources = set([ 'cloudfront', diff --git a/plugins/modules/dynamodb_table.py b/plugins/modules/dynamodb_table.py index 7a3add3727a..b23c443cac9 100644 --- a/plugins/modules/dynamodb_table.py +++ b/plugins/modules/dynamodb_table.py @@ -19,8 +19,8 @@ requirements: - python >= 3.6 - boto >= 2.49.0 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.13.0 +- botocore >= 1.16.0 options: state: description: diff --git a/plugins/modules/ec2_eip.py b/plugins/modules/ec2_eip.py index 927d31551b7..adf6f0bda41 100644 --- a/plugins/modules/ec2_eip.py +++ b/plugins/modules/ec2_eip.py @@ -344,11 +344,10 @@ def address_is_associated_with_device(ec2, module, address, device_id, is_instan def allocate_address(ec2, module, domain, reuse_existing_ip_allowed, check_mode, tag_dict=None, public_ipv4_pool=None): """ Allocate a new elastic IP address (when needed) and return it """ - if not domain: - domain = 'standard' - if reuse_existing_ip_allowed: filters = [] + if not domain: + domain = 'standard' filters.append({'Name': 'domain', "Values": [domain]}) if tag_dict is not None: diff --git a/plugins/modules/elasticache_subnet_group.py b/plugins/modules/elasticache_subnet_group.py index eda678205d0..44a3e39ae6f 100644 --- a/plugins/modules/elasticache_subnet_group.py +++ b/plugins/modules/elasticache_subnet_group.py @@ -12,36 +12,34 @@ version_added: 1.0.0 short_description: manage ElastiCache subnet groups description: - - Creates, modifies, and deletes ElastiCache subnet groups. + - Creates, modifies, and deletes ElastiCache subnet groups. This module has a dependency on python-boto >= 2.5. options: state: description: - Specifies whether the subnet should be present or absent. + required: true choices: [ 'present' , 'absent' ] - default: 'present' type: str name: description: - Database subnet group identifier. - - This value is automatically converted to lowercase. required: true type: str description: description: - - ElastiCache subnet group description. - - When not provided defaults to I(name) on subnet group creation. + - ElastiCache subnet group description. Only set when a new group is added. type: str subnets: description: - List of subnet IDs that make up the ElastiCache subnet group. - - At least one subnet must be provided when creating an ElastiCache subnet group. type: list elements: str -author: - - "Tim Mahoney (@timmahoney)" +author: "Tim Mahoney (@timmahoney)" extends_documentation_fragment: - - amazon.aws.aws - - amazon.aws.ec2 +- amazon.aws.aws +- amazon.aws.ec2 +requirements: +- boto >= 2.49.0 ''' EXAMPLES = r''' @@ -60,195 +58,87 @@ name: norwegian-blue ''' -RETURN = r''' -cache_subnet_group: - description: Description of the Elasticache Subnet Group. - returned: always - type: dict - contains: - arn: - description: The Amazon Resource Name (ARN) of the cache subnet group. - returned: when the subnet group exists - type: str - sample: arn:aws:elasticache:us-east-1:012345678901:subnetgroup:norwegian-blue - description: - description: The description of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: My Fancy Ex Parrot Subnet Group - name: - description: The name of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: norwegian-blue - vpc_id: - description: The VPC ID of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: norwegian-blue - subnet_ids: - description: The IDs of the subnets beloging to the cache subnet group. - returned: when the cache subnet group exists - type: list - elements: str - sample: - - subnet-aaaaaaaa - - subnet-bbbbbbbb -''' - try: - import botocore + import boto + from boto.elasticache import connect_to_region + from boto.exception import BotoServerError except ImportError: - pass # Handled by AnsibleAWSModule - -from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict + pass # Handled by HAS_BOTO +from ansible.module_utils._text import to_native from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry - - -def get_subnet_group(name): - try: - groups = client.describe_cache_subnet_groups( - aws_retry=True, - CacheSubnetGroupName=name, - )['CacheSubnetGroups'] - except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): - return None - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to describe subnet group") - - if not groups: - return None - - if len(groups) > 1: - module.fail_aws( - msg="Found multiple matches for subnet group", - cache_subnet_groups=camel_dict_to_snake_dict(groups), - ) - - subnet_group = camel_dict_to_snake_dict(groups[0]) - - subnet_group['name'] = subnet_group['cache_subnet_group_name'] - subnet_group['description'] = subnet_group['cache_subnet_group_description'] - - subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) - subnet_group['subnet_ids'] = subnet_ids - - return subnet_group - - -def create_subnet_group(name, description, subnets): - - if not subnets: - module.fail_json(msg='At least one subnet must be provided when creating a subnet group') - - if module.check_mode: - return True - - try: - if not description: - description = name - client.create_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - CacheSubnetGroupDescription=description, - SubnetIds=subnets, - ) - return True - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to create subnet group") - - -def update_subnet_group(subnet_group, name, description, subnets): - update_params = dict() - if description and subnet_group['description'] != description: - update_params['CacheSubnetGroupDescription'] = description - if subnets: - old_subnets = set(subnet_group['subnet_ids']) - new_subnets = set(subnets) - if old_subnets != new_subnets: - update_params['SubnetIds'] = list(subnets) - - if not update_params: - return False - - if module.check_mode: - return True - - try: - client.modify_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - **update_params, - ) - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to update subnet group") - - return True - - -def delete_subnet_group(name): - - if module.check_mode: - return True - - try: - client.delete_cache_subnet_group( - aws_retry=True, - CacheSubnetGroupName=name, - ) - return True - except is_boto3_error_code('CacheSubnetGroupNotFoundFault'): - # AWS is "eventually consistent", cope with the race conditions where - # deletion hadn't completed when we ran describe - return False - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to delete subnet group") +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info def main(): argument_spec = dict( - state=dict(default='present', choices=['present', 'absent']), + state=dict(required=True, choices=['present', 'absent']), name=dict(required=True), description=dict(required=False), subnets=dict(required=False, type='list', elements='str'), ) + module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - global module - global client - - module = AnsibleAWSModule( - argument_spec=argument_spec, - supports_check_mode=True, - ) + if not HAS_BOTO: + module.fail_json(msg='boto required for this module') state = module.params.get('state') - name = module.params.get('name').lower() - description = module.params.get('description') - subnets = module.params.get('subnets') + group_name = module.params.get('name').lower() + group_description = module.params.get('description') + group_subnets = module.params.get('subnets') or {} - client = module.client('elasticache', retry_decorator=AWSRetry.jittered_backoff()) + if state == 'present': + for required in ['name', 'description', 'subnets']: + if not module.params.get(required): + module.fail_json(msg=str("Parameter %s required for state='present'" % required)) + else: + for not_allowed in ['description', 'subnets']: + if module.params.get(not_allowed): + module.fail_json(msg=str("Parameter %s not allowed for state='absent'" % not_allowed)) - subnet_group = get_subnet_group(name) - changed = False + # Retrieve any AWS settings from the environment. + region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module) - if state == 'present': - if not subnet_group: - result = create_subnet_group(name, description, subnets) - changed |= result + if not region: + module.fail_json(msg=str("Either region or AWS_REGION or EC2_REGION environment variable or boto config aws_region or ec2_region must be set.")) + + """Get an elasticache connection""" + try: + conn = connect_to_region(region_name=region, **aws_connect_kwargs) + except boto.exception.NoAuthHandlerFound as e: + module.fail_json(msg=to_native(e)) + + try: + changed = False + exists = False + + try: + matching_groups = conn.describe_cache_subnet_groups(group_name, max_records=100) + exists = len(matching_groups) > 0 + except BotoServerError as e: + if e.error_code != 'CacheSubnetGroupNotFoundFault': + module.fail_json(msg=e.error_message) + + if state == 'absent': + if exists: + conn.delete_cache_subnet_group(group_name) + changed = True else: - result = update_subnet_group(subnet_group, name, description, subnets) - changed |= result - subnet_group = get_subnet_group(name) - else: - if subnet_group: - result = delete_subnet_group(name) - changed |= result - subnet_group = None + if not exists: + new_group = conn.create_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) + changed = True + else: + changed_group = conn.modify_cache_subnet_group(group_name, cache_subnet_group_description=group_description, subnet_ids=group_subnets) + changed = True + + except BotoServerError as e: + if e.error_message != 'No modifications were requested.': + module.fail_json(msg=e.error_message) + else: + changed = False - module.exit_json(changed=changed, cache_subnet_group=subnet_group) + module.exit_json(changed=changed) if __name__ == '__main__': diff --git a/plugins/modules/elb_target_group.py b/plugins/modules/elb_target_group.py index 9a740422293..45649e7e651 100644 --- a/plugins/modules/elb_target_group.py +++ b/plugins/modules/elb_target_group.py @@ -161,23 +161,6 @@ - The identifier of the virtual private cloud (VPC). Required when I(state) is C(present). required: false type: str - preserve_client_ip_enabled: - description: - - Indicates whether client IP preservation is enabled. - - The default is disabled if the target group type is C(ip) address and the target group protocol is C(tcp) or C(tls). - Otherwise, the default is enabled. Client IP preservation cannot be disabled for C(udp) and C(tcp_udp) target groups. - - I(preserve_client_ip_enabled) is supported only by Network Load Balancers. - type: bool - required: false - version_added: 2.1.0 - proxy_protocol_v2_enabled: - description: - - Indicates whether Proxy Protocol version 2 is enabled. - - The value is C(true) or C(false). - - I(proxy_protocol_v2_enabled) is supported only by Network Load Balancers. - type: bool - required: false - version_added: 2.1.0 wait: description: - Whether or not to wait for the target group. @@ -491,8 +474,6 @@ def create_or_update_target_group(connection, module): stickiness_type = module.params.get("stickiness_type") stickiness_app_cookie_duration = module.params.get("stickiness_app_cookie_duration") stickiness_app_cookie_name = module.params.get("stickiness_app_cookie_name") - preserve_client_ip_enabled = module.params.get("preserve_client_ip_enabled") - proxy_protocol_v2_enabled = module.params.get("proxy_protocol_v2_enabled") health_option_keys = [ "health_check_path", "health_check_protocol", "health_check_interval", "health_check_timeout", @@ -782,13 +763,6 @@ def create_or_update_target_group(connection, module): if stickiness_app_cookie_duration is not None: if str(stickiness_app_cookie_duration) != current_tg_attributes['stickiness_app_cookie_duration_seconds']: update_attributes.append({'Key': 'stickiness.app_cookie.duration_seconds', 'Value': str(stickiness_app_cookie_duration)}) - if preserve_client_ip_enabled is not None: - if target_type not in ('udp', 'tcp_udp'): - if str(preserve_client_ip_enabled).lower() != current_tg_attributes.get('preserve_client_ip_enabled'): - update_attributes.append({'Key': 'preserve_client_ip.enabled', 'Value': str(preserve_client_ip_enabled).lower()}) - if proxy_protocol_v2_enabled is not None: - if str(proxy_protocol_v2_enabled).lower() != current_tg_attributes.get('proxy_protocol_v2_enabled'): - update_attributes.append({'Key': 'proxy_protocol_v2.enabled', 'Value': str(proxy_protocol_v2_enabled).lower()}) if update_attributes: try: @@ -878,8 +852,6 @@ def main(): targets=dict(type='list', elements='dict'), unhealthy_threshold_count=dict(type='int'), vpc_id=dict(), - preserve_client_ip_enabled=dict(type='bool'), - proxy_protocol_v2_enabled=dict(type='bool'), wait_timeout=dict(type='int', default=200), wait=dict(type='bool', default=False) ) diff --git a/plugins/modules/iam_server_certificate.py b/plugins/modules/iam_cert.py similarity index 88% rename from plugins/modules/iam_server_certificate.py rename to plugins/modules/iam_cert.py index 5402b22d126..fbe984670aa 100644 --- a/plugins/modules/iam_server_certificate.py +++ b/plugins/modules/iam_cert.py @@ -20,7 +20,7 @@ DOCUMENTATION = ''' --- -module: iam_server_certificate +module: iam_cert version_added: 1.0.0 short_description: Manage server certificates for use on ELBs and CloudFront description: @@ -56,23 +56,17 @@ cert_chain: description: - The path to, or content of, the CA certificate chain in PEM encoded format. - - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str cert: description: - The path to, or content of the certificate body in PEM encoded format. - - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str key: description: - The path to, or content of the private key in PEM encoded format. - If the parameter is not a file, it is assumed to be content. - - Passing a file name is deprecated, and support will be dropped in - version 4.0.0 of this collection. + As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content. type: str dup_ok: description: @@ -91,7 +85,7 @@ EXAMPLES = ''' - name: Basic server certificate upload from local file - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present cert: "{{ lookup('file', 'path/to/cert') }}" @@ -99,7 +93,7 @@ cert_chain: "{{ lookup('file', 'path/to/certchain') }}" - name: Basic server certificate upload - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present cert: path/to/cert @@ -107,7 +101,7 @@ cert_chain: path/to/certchain - name: Server certificate upload using key string - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl state: present path: "/a/cert/path/" @@ -116,7 +110,7 @@ cert_chain: body_of_myverytrustedchain - name: Basic rename of existing certificate - community.aws.iam_server_certificate: + community.aws.iam_cert: name: very_ssl new_name: new_very_ssl state: present @@ -237,31 +231,16 @@ def load_data(cert, key, cert_chain): if cert and os.path.isfile(cert): with open(cert, 'r') as cert_fh: cert = cert_fh.read().rstrip() - module.deprecate( - 'Passing a file name as the cert argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') if key and os.path.isfile(key): with open(key, 'r') as key_fh: key = key_fh.read().rstrip() - module.deprecate( - 'Passing a file name as the key argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') if cert_chain and os.path.isfile(cert_chain): with open(cert_chain, 'r') as cert_chain_fh: cert_chain = cert_chain_fh.read() - module.deprecate( - 'Passing a file name as the cert_chain argument has been deprecated. ' - 'Please use a lookup instead, see the documentation for examples.', - version='4.0.0', collection_name='community.aws') return cert, key, cert_chain def main(): - - global module - argument_spec = dict( state=dict(required=True, choices=['present', 'absent']), name=dict(required=True), diff --git a/plugins/modules/rds_instance_info.py b/plugins/modules/rds_instance_info.py index 13609972c17..fba7804012a 100644 --- a/plugins/modules/rds_instance_info.py +++ b/plugins/modules/rds_instance_info.py @@ -234,11 +234,6 @@ returned: always type: str sample: '2017-10-10T04:00:07.434000+00:00' - iops: - description: The Provisioned IOPS value for the DB instance. - returned: always - type: int - sample: 1000 kms_key_id: description: KMS Key ID returned: always diff --git a/plugins/modules/redshift_subnet_group.py b/plugins/modules/redshift_subnet_group.py index 89e8bfa8042..fa210a5bee4 100644 --- a/plugins/modules/redshift_subnet_group.py +++ b/plugins/modules/redshift_subnet_group.py @@ -9,6 +9,8 @@ DOCUMENTATION = r''' --- +author: + - "Jens Carl (@j-carl), Hothead Games Inc." module: redshift_subnet_group version_added: 1.0.0 short_description: manage Redshift cluster subnet groups @@ -17,33 +19,32 @@ options: state: description: - - Specifies whether the subnet group should be present or absent. - default: 'present' + - Specifies whether the subnet should be present or absent. + required: true choices: ['present', 'absent' ] type: str - name: + group_name: description: - Cluster subnet group name. required: true - aliases: ['group_name'] + aliases: ['name'] type: str - description: + group_description: description: - - Cluster subnet group description. - aliases: ['group_description'] + - Database subnet group description. + aliases: ['description'] type: str - subnets: + group_subnets: description: - List of subnet IDs that make up the cluster subnet group. - - At least one subnet must be provided when creating a cluster subnet group. - aliases: ['group_subnets'] + aliases: ['subnets'] type: list elements: str extends_documentation_fragment: - amazon.aws.aws - amazon.aws.ec2 -author: - - "Jens Carl (@j-carl), Hothead Games Inc." +requirements: +- boto >= 2.49.0 ''' EXAMPLES = r''' @@ -63,209 +64,113 @@ ''' RETURN = r''' -cluster_subnet_group: - description: A dictionary containing information about the Redshift subnet group. +group: + description: dictionary containing all Redshift subnet group information returned: success - type: dict + type: complex contains: name: - description: Name of the Redshift subnet group. - returned: when the cache subnet group exists + description: name of the Redshift subnet group + returned: success type: str sample: "redshift_subnet_group_name" vpc_id: - description: Id of the VPC where the subnet is located. - returned: when the cache subnet group exists + description: Id of the VPC where the subnet is located + returned: success type: str sample: "vpc-aabb1122" - description: - description: The description of the cache subnet group. - returned: when the cache subnet group exists - type: str - sample: Redshift subnet - subnet_ids: - description: The IDs of the subnets beloging to the Redshift subnet group. - returned: when the cache subnet group exists - type: list - elements: str - sample: - - subnet-aaaaaaaa - - subnet-bbbbbbbb ''' try: - import botocore + import boto + import boto.redshift except ImportError: - pass # Handled by AnsibleAWSModule - -from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict + pass # Handled by HAS_BOTO from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict - - -def get_subnet_group(name): - try: - groups = client.describe_cluster_subnet_groups( - aws_retry=True, - ClusterSubnetGroupName=name, - )['ClusterSubnetGroups'] - except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): - return None - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to describe subnet group") - - if not groups: - return None - - if len(groups) > 1: - module.fail_aws( - msg="Found multiple matches for subnet group", - cluster_subnet_groups=camel_dict_to_snake_dict(groups), - ) - - # No support for managing tags yet, but make sure that we don't need to - # change the return value structure after it's been available in a release. - tags = boto3_tag_list_to_ansible_dict(groups[0]['Tags']) - - subnet_group = camel_dict_to_snake_dict(groups[0]) - - subnet_group['tags'] = tags - subnet_group['name'] = subnet_group['cluster_subnet_group_name'] - - subnet_ids = list(s['subnet_identifier'] for s in subnet_group['subnets']) - subnet_group['subnet_ids'] = subnet_ids - - return subnet_group - - -def create_subnet_group(name, description, subnets): - - if not subnets: - module.fail_json(msg='At least one subnet must be provided when creating a subnet group') - - if module.check_mode: - return True - - try: - if not description: - description = name - client.create_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - Description=description, - SubnetIds=subnets, - ) - return True - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to create subnet group") - - -def update_subnet_group(subnet_group, name, description, subnets): - update_params = dict() - if description and subnet_group['description'] != description: - update_params['Description'] = description - if subnets: - old_subnets = set(subnet_group['subnet_ids']) - new_subnets = set(subnets) - if old_subnets != new_subnets: - update_params['SubnetIds'] = list(subnets) - - if not update_params: - return False - - if module.check_mode: - return True - - # Description is optional, SubnetIds is not - if 'SubnetIds' not in update_params: - update_params['SubnetIds'] = subnet_group['subnet_ids'] - - try: - client.modify_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - **update_params, - ) - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: - module.fail_json_aws(e, msg="Failed to update subnet group") - - return True - - -def delete_subnet_group(name): - - if module.check_mode: - return True - - try: - client.delete_cluster_subnet_group( - aws_retry=True, - ClusterSubnetGroupName=name, - ) - return True - except is_boto3_error_code('ClusterSubnetGroupNotFoundFault'): - # AWS is "eventually consistent", cope with the race conditions where - # deletion hadn't completed when we ran describe - return False - except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: # pylint: disable=duplicate-except - module.fail_json_aws(e, msg="Failed to delete subnet group") +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import HAS_BOTO +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import connect_to_aws +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import get_aws_connection_info def main(): argument_spec = dict( - state=dict(default='present', choices=['present', 'absent']), - name=dict(required=True, aliases=['group_name']), - description=dict(required=False, aliases=['group_description']), - subnets=dict(required=False, aliases=['group_subnets'], type='list', elements='str'), + state=dict(required=True, choices=['present', 'absent']), + group_name=dict(required=True, aliases=['name']), + group_description=dict(required=False, aliases=['description']), + group_subnets=dict(required=False, aliases=['subnets'], type='list', elements='str'), ) + module = AnsibleAWSModule(argument_spec=argument_spec, check_boto3=False) - global module - global client - - module = AnsibleAWSModule( - argument_spec=argument_spec, - supports_check_mode=True, - ) + if not HAS_BOTO: + module.fail_json(msg='boto v2.9.0+ required for this module') state = module.params.get('state') - name = module.params.get('name') - description = module.params.get('description') - subnets = module.params.get('subnets') - - client = module.client('redshift', retry_decorator=AWSRetry.jittered_backoff()) - - subnet_group = get_subnet_group(name) - changed = False + group_name = module.params.get('group_name') + group_description = module.params.get('group_description') + group_subnets = module.params.get('group_subnets') if state == 'present': - if not subnet_group: - result = create_subnet_group(name, description, subnets) - changed |= result - else: - result = update_subnet_group(subnet_group, name, description, subnets) - changed |= result - subnet_group = get_subnet_group(name) + for required in ('group_name', 'group_description', 'group_subnets'): + if not module.params.get(required): + module.fail_json(msg=str("parameter %s required for state='present'" % required)) else: - if subnet_group: - result = delete_subnet_group(name) - changed |= result - subnet_group = None + for not_allowed in ('group_description', 'group_subnets'): + if module.params.get(not_allowed): + module.fail_json(msg=str("parameter %s not allowed for state='absent'" % not_allowed)) - compat_results = dict() - if subnet_group: - compat_results['group'] = dict( - name=subnet_group['name'], - vpc_id=subnet_group['vpc_id'], - ) + region, ec2_url, aws_connect_params = get_aws_connection_info(module) + if not region: + module.fail_json(msg=str("Region must be specified as a parameter, in EC2_REGION or AWS_REGION environment variables or in boto configuration file")) - module.exit_json( - changed=changed, - cluster_subnet_group=subnet_group, - **compat_results, - ) + # Connect to the Redshift endpoint. + try: + conn = connect_to_aws(boto.redshift, region, **aws_connect_params) + except boto.exception.JSONResponseError as e: + module.fail_json(msg=str(e)) + + try: + changed = False + exists = False + group = None + + try: + matching_groups = conn.describe_cluster_subnet_groups(group_name, max_records=100) + exists = len(matching_groups) > 0 + except boto.exception.JSONResponseError as e: + if e.body['Error']['Code'] != 'ClusterSubnetGroupNotFoundFault': + # if e.code != 'ClusterSubnetGroupNotFoundFault': + module.fail_json(msg=str(e)) + + if state == 'absent': + if exists: + conn.delete_cluster_subnet_group(group_name) + changed = True + + else: + if not exists: + new_group = conn.create_cluster_subnet_group(group_name, group_description, group_subnets) + group = { + 'name': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['ClusterSubnetGroupName'], + 'vpc_id': new_group['CreateClusterSubnetGroupResponse']['CreateClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['VpcId'], + } + else: + changed_group = conn.modify_cluster_subnet_group(group_name, group_subnets, description=group_description) + group = { + 'name': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['ClusterSubnetGroupName'], + 'vpc_id': changed_group['ModifyClusterSubnetGroupResponse']['ModifyClusterSubnetGroupResult'] + ['ClusterSubnetGroup']['VpcId'], + } + + changed = True + + except boto.exception.JSONResponseError as e: + module.fail_json(msg=str(e)) + + module.exit_json(changed=changed, group=group) if __name__ == '__main__': diff --git a/plugins/modules/route53.py b/plugins/modules/route53.py index d4fe99531c0..d1391cfac58 100644 --- a/plugins/modules/route53.py +++ b/plugins/modules/route53.py @@ -606,7 +606,6 @@ def main(): 'TTL': ttl_in, 'ResourceRecords': [dict(Value=value) for value in value_in], 'HealthCheckId': health_check_in, - 'SetIdentifier': identifier_in, }) if alias_in: diff --git a/plugins/modules/sns_topic.py b/plugins/modules/sns_topic.py index 37cf573ce58..dd5af417bab 100644 --- a/plugins/modules/sns_topic.py +++ b/plugins/modules/sns_topic.py @@ -49,73 +49,6 @@ description: - Delivery policy to apply to the SNS topic. type: dict - suboptions: - http: - description: - - Delivery policy for HTTP(S) messages. - - See U(https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) - for more information. - type: dict - required: false - suboptions: - disableSubscriptionOverrides: - description: - - Applies this policy to all subscriptions, even if they have their own policies. - type: bool - required: false - defaultThrottlePolicy: - description: - - Throttle the rate of messages sent to subsriptions. - type: dict - suboptions: - maxReceivesPerSecond: - description: - - The maximum number of deliveries per second per subscription. - type: int - required: true - required: false - defaultHealthyRetryPolicy: - description: - - Retry policy for HTTP(S) messages. - type: dict - required: true - suboptions: - minDelayTarget: - description: - - The minimum delay for a retry. - type: int - required: true - maxDelayTarget: - description: - - The maximum delay for a retry. - type: int - required: true - numRetries: - description: - - The total number of retries. - type: int - required: true - numMaxDelayRetries: - description: - - The number of retries with the maximum delay between them. - type: int - required: true - numMinDelayRetries: - description: - - The number of retries with just the minimum delay between them. - type: int - required: true - numNoDelayRetries: - description: - - The number of retries to be performmed immediately. - type: int - required: true - backoffFunction: - description: - - The function for backoff between retries. - type: str - required: true - choices: ['arithmetic', 'exponential', 'geometric', 'linear'] subscriptions: description: - List of subscriptions to apply to the topic. Note that AWS requires @@ -292,12 +225,8 @@ except ImportError: pass # handled by AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule -from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code -from ansible_collections.amazon.aws.plugins.module_utils.core import scrub_none_parameters -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry -from ansible_collections.amazon.aws.plugins.module_utils.ec2 import camel_dict_to_snake_dict +from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule, is_boto3_error_code +from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_policies, AWSRetry, camel_dict_to_snake_dict class SnsTopicManager(object): @@ -322,7 +251,7 @@ def __init__(self, self.state = state self.display_name = display_name self.policy = policy - self.delivery_policy = scrub_none_parameters(delivery_policy) if delivery_policy else None + self.delivery_policy = delivery_policy self.subscriptions = subscriptions self.subscriptions_existing = [] self.subscriptions_deleted = [] @@ -566,39 +495,13 @@ def get_info(self): def main(): - - # We're kinda stuck with CamelCase here, it would be nice to switch to - # snake_case, but we'd need to purge out the alias entries - http_retry_args = dict( - minDelayTarget=dict(type='int', required=True), - maxDelayTarget=dict(type='int', required=True), - numRetries=dict(type='int', required=True), - numMaxDelayRetries=dict(type='int', required=True), - numMinDelayRetries=dict(type='int', required=True), - numNoDelayRetries=dict(type='int', required=True), - backoffFunction=dict(type='str', required=True, choices=['arithmetic', 'exponential', 'geometric', 'linear']), - ) - http_delivery_args = dict( - defaultHealthyRetryPolicy=dict(type='dict', required=True, options=http_retry_args), - disableSubscriptionOverrides=dict(type='bool', required=False), - defaultThrottlePolicy=dict( - type='dict', required=False, - options=dict( - maxReceivesPerSecond=dict(type='int', required=True), - ), - ), - ) - delivery_args = dict( - http=dict(type='dict', required=False, options=http_delivery_args), - ) - argument_spec = dict( name=dict(required=True), topic_type=dict(type='str', default='standard', choices=['standard', 'fifo']), state=dict(default='present', choices=['present', 'absent']), display_name=dict(), policy=dict(type='dict'), - delivery_policy=dict(type='dict', options=delivery_args), + delivery_policy=dict(type='dict'), subscriptions=dict(default=[], type='list', elements='dict'), purge_subscriptions=dict(type='bool', default=True), ) diff --git a/requirements.txt b/requirements.txt index 3685e404330..0d58b96112d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,3 @@ -# When updating the minimal requirements please also update -# - tests/unit/constraints.txt -# - tests/integration/constraints.txt -# - tests/integration/targets/setup_botocore_pip -botocore>=1.18.0 -boto3>=1.15.0 -# Final released version boto>=2.49.0 +botocore>=1.16.0 +boto3>=1.13.0 diff --git a/test-requirements.txt b/test-requirements.txt index 77c76b86509..3d217284154 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,3 @@ -botocore -boto3 -boto - coverage==4.5.4 placebo mock @@ -12,5 +8,3 @@ pytest-mock netaddr # Sometimes needed where we don't have features we need in modules awscli -# Used for comparing SSH Public keys to the Amazon fingerprints -pycrypto diff --git a/tests/config.yml b/tests/config.yml deleted file mode 100644 index 5112f726881..00000000000 --- a/tests/config.yml +++ /dev/null @@ -1,2 +0,0 @@ -modules: - python_requires: '>=3.6' diff --git a/tests/integration/constraints.txt b/tests/integration/constraints.txt index bd95eb26733..c105f290280 100644 --- a/tests/integration/constraints.txt +++ b/tests/integration/constraints.txt @@ -1,7 +1,3 @@ -# Specifically run tests against the oldest versions that we support -boto3==1.15.0 -botocore==1.18.0 +boto3 >= 1.9.250, <= 1.15.18 # minimum version that supports botocore 1.13.3, max that will work with ansible 2.9's other constraints +botocore<1.19.0,>=1.13.3 # adds support for ECR image scanning -# AWS CLI has `botocore==` dependencies, provide the one that matches botocore -# to avoid needing to download over a years worth of awscli wheels. -awscli==1.18.141 diff --git a/tests/integration/requirements.txt b/tests/integration/requirements.txt index 6e870975a35..2fb8f547d8a 100644 --- a/tests/integration/requirements.txt +++ b/tests/integration/requirements.txt @@ -1,12 +1,5 @@ -# Our code is based on the AWS SDKs -boto -boto3 -botocore - # netaddr is needed for ansible.netcommon.ipv6 netaddr virtualenv -# Sometimes needed where we don't have features we need in modules -awscli -# Used for comparing SSH Public keys to the Amazon fingerprints -pycrypto +boto3 +botocore diff --git a/tests/integration/targets/aws_msk_cluster/tasks/main.yml b/tests/integration/targets/aws_msk_cluster/tasks/main.yml index a3049dad0b4..9ace1814f81 100644 --- a/tests/integration/targets/aws_msk_cluster/tasks/main.yml +++ b/tests/integration/targets/aws_msk_cluster/tasks/main.yml @@ -40,38 +40,60 @@ - set_fact: subnet_ids: '{{ subnets | community.general.json_query("results[].subnet.id") | list }}' + - pip: + name: virtualenv + - set_fact: + virtualenv: "{{ remote_tmp_dir }}/virtualenv" + virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" + - set_fact: + virtualenv_interpreter: "{{ virtualenv }}/bin/python" + - pip: + name: + - 'boto3>=1.13.0' + - 'botocore==1.17.48' + - 'coverage<5' + virtualenv: '{{ virtualenv }}' + virtualenv_command: '{{ virtualenv_command }}' + virtualenv_site_packages: no + # ============================================================ - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: - - "{{ msk_version }}" - register: msk_config + - name: Wrap test in virtualenv + vars: + ansible_python_interpreter: "{{ virtualenv }}/bin/python" + block: + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: + - "{{ msk_version }}" + register: msk_config - - name: create tests - include_tasks: test_create.yml + - name: create tests + include_tasks: test_create.yml - - name: update tests - include_tasks: test_update.yml + - name: update tests + include_tasks: test_update.yml - - name: delete tests - include_tasks: test_delete.yml + - name: delete tests + include_tasks: test_delete.yml - always: + always: - - name: delete msk cluster - aws_msk_cluster: - name: "{{ msk_cluster_name }}" - state: absent - wait: true - ignore_errors: yes + - name: delete msk cluster + aws_msk_cluster: + name: "{{ msk_cluster_name }}" + state: absent + wait: true + ignore_errors: yes - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes + + always: - name: remove subnets ec2_vpc_subnet: diff --git a/tests/integration/targets/aws_msk_config/tasks/main.yml b/tests/integration/targets/aws_msk_config/tasks/main.yml index cef9e1dfc90..d29631c1930 100644 --- a/tests/integration/targets/aws_msk_config/tasks/main.yml +++ b/tests/integration/targets/aws_msk_config/tasks/main.yml @@ -9,140 +9,161 @@ collections: - amazon.aws block: - - name: create msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be created - assert: - that: - - msk_config is changed - - - name: create msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration is created - assert: - that: - - msk_config is changed - - - name: create msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[0] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: validate return values - assert: - that: - - msk_config.revision == 1 - - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" - - "'auto.create.topics.enable=True' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" - - - name: update msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: update msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: validate return values (update) - assert: - that: - - msk_config.revision == 2 - - "'auto.create.topics.enable=True' not in msk_config.server_properties" - - "'num.io.threads=8' in msk_config.server_properties" - - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" - - - name: update msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "present" - kafka_versions: "{{ msk_kafka_versions }}" - config: "{{ msk_configs[1] }}" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - - name: delete msk configuration (check mode) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - check_mode: yes - register: msk_config - - - name: assert that the msk configuration be changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration is changed - assert: - that: - - msk_config is changed - - - name: delete msk configuration (idempotency) - aws_msk_config: - name: "{{ msk_config_name }}" - state: "absent" - register: msk_config - - - name: assert that the msk configuration wasn't changed - assert: - that: - - msk_config is not changed - - always: - - - name: remove msk configuration - aws_msk_config: - name: "{{ msk_config_name }}" - state: absent - ignore_errors: yes + + - pip: + name: virtualenv + - set_fact: + virtualenv: "{{ remote_tmp_dir }}/virtualenv" + virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" + - set_fact: + virtualenv_interpreter: "{{ virtualenv }}/bin/python" + - pip: + name: + - 'boto3>=1.13.0' + - 'botocore==1.17.48' + - 'coverage<5' + virtualenv: '{{ virtualenv }}' + virtualenv_command: '{{ virtualenv_command }}' + virtualenv_site_packages: no + + - name: Wrap test in virtualenv + vars: + ansible_python_interpreter: "{{ virtualenv }}/bin/python" + block: + - name: create msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be created + assert: + that: + - msk_config is changed + + - name: create msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration is created + assert: + that: + - msk_config is changed + + - name: create msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[0] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: validate return values + assert: + that: + - msk_config.revision == 1 + - "msk_config.arn.startswith('arn:aws:kafka:{{ aws_region }}:')" + - "'auto.create.topics.enable=True' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=18000' in msk_config.server_properties" + + - name: update msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: update msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: validate return values (update) + assert: + that: + - msk_config.revision == 2 + - "'auto.create.topics.enable=True' not in msk_config.server_properties" + - "'num.io.threads=8' in msk_config.server_properties" + - "'zookeeper.session.timeout.ms=36000' in msk_config.server_properties" + + - name: update msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "present" + kafka_versions: "{{ msk_kafka_versions }}" + config: "{{ msk_configs[1] }}" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + - name: delete msk configuration (check mode) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + check_mode: yes + register: msk_config + + - name: assert that the msk configuration be changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration is changed + assert: + that: + - msk_config is changed + + - name: delete msk configuration (idempotency) + aws_msk_config: + name: "{{ msk_config_name }}" + state: "absent" + register: msk_config + + - name: assert that the msk configuration wasn't changed + assert: + that: + - msk_config is not changed + + always: + + - name: remove msk configuration + aws_msk_config: + name: "{{ msk_config_name }}" + state: absent + ignore_errors: yes diff --git a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml index 77c193043a9..8dd14bfbd42 100644 --- a/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml +++ b/tests/integration/targets/aws_s3_bucket_info/tasks/bucket_ownership_controls.yml @@ -10,7 +10,7 @@ virtualenv_interpreter: "{{ virtualenv }}/bin/python" - pip: name: - - 'boto3>=1.15.0' + - 'boto3>=1.13.0' - 'botocore==1.18.11' - 'coverage<5' virtualenv: '{{ virtualenv }}' diff --git a/tests/integration/targets/dynamodb_table/aliases b/tests/integration/targets/dynamodb_table/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/dynamodb_table/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/dynamodb_table/defaults/main.yml b/tests/integration/targets/dynamodb_table/defaults/main.yml deleted file mode 100644 index 47fc4243153..00000000000 --- a/tests/integration/targets/dynamodb_table/defaults/main.yml +++ /dev/null @@ -1,47 +0,0 @@ ---- -table_name: '{{ resource_prefix }}' - -table_index: 'id' -table_index_type: 'NUMBER' - -range_index: 'variety' -range_index_type: 'STRING' - -indexes: - - name: NamedIndex - type: global_include - hash_key_name: idx - range_key_name: create_time - includes: - - other_field - - other_field2 - read_capacity: 10 - write_capacity: 10 - - name: AnotherIndex - type: global_all - hash_key_name: foo - range_key_name: bar - includes: - - another_field - - another_field2 - read_capacity: 5 - write_capacity: 5 - - -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/dynamodb_table/meta/main.yml b/tests/integration/targets/dynamodb_table/meta/main.yml deleted file mode 100644 index 07faa217762..00000000000 --- a/tests/integration/targets/dynamodb_table/meta/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -dependencies: - - prepare_tests diff --git a/tests/integration/targets/dynamodb_table/tasks/main.yml b/tests/integration/targets/dynamodb_table/tasks/main.yml deleted file mode 100644 index 938351f5625..00000000000 --- a/tests/integration/targets/dynamodb_table/tasks/main.yml +++ /dev/null @@ -1,733 +0,0 @@ ---- -# dynamodb_table integration tests -# -# Current module limitations: -# - changed very flakey -# - various parameters have defaults set so reset undefined value -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================== - - - name: Create table - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - check_mode: True - - - name: Check results - Create table - check_mode - assert: - that: - - create_table is successful - - create_table is changed - - '"hash_key_name" in create_table' - - - name: Create table - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - - - name: Check results - Create table - assert: - that: - - create_table is successful - - create_table is changed - - '"hash_key_name" in create_table' - - '"hash_key_type" in create_table' - - '"indexes" in create_table' - - '"range_key_name" in create_table' - - '"range_key_type" in create_table' - - '"read_capacity" in create_table' - - '"region" in create_table' - - '"table_name" in create_table' - - '"table_status" in create_table' - - '"write_capacity" in create_table' - - create_table.hash_key_name == table_index - - create_table.hash_key_type == table_index_type - - create_table.indexes | length == 0 - - create_table.range_key_name is none - - create_table.range_key_type == "STRING" - - create_table.read_capacity == 1 - - create_table.table_name == table_name - - create_table.write_capacity == 1 - - - name: Create table - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - check_mode: True - - - name: Check results - Create table - idempotent - check_mode - assert: - that: - - create_table is successful - - create_table is not changed - - - name: Create table - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - hash_key_name: '{{ table_index }}' - hash_key_type: '{{ table_index_type }}' - register: create_table - - - name: Check results - Create table - idempotent - assert: - that: - - create_table is successful - - create_table is not changed - - '"hash_key_name" in create_table' - - '"hash_key_type" in create_table' - - '"indexes" in create_table' - - '"range_key_name" in create_table' - - '"range_key_type" in create_table' - - '"read_capacity" in create_table' - - '"region" in create_table' - - '"table_name" in create_table' - - '"table_status" in create_table' - - '"write_capacity" in create_table' - - create_table.hash_key_name == table_index - - create_table.hash_key_type == table_index_type - - create_table.indexes | length == 0 - - create_table.range_key_name is none - - create_table.range_key_type == "STRING" - - create_table.read_capacity == 1 - - create_table.table_name == table_name - - create_table.write_capacity == 1 - - # ============================================== - - - name: Tag table - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - check_mode: True - - - name: Check results - Tag table - check_mode - assert: - that: - - tag_table is successful - # XXX bug updating (just) tags doesn't return 'changed' - # - tag_table is changed - - - name: Tag table - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - - - name: Check results - Tag table - assert: - that: - - tag_table is successful - # XXX bug updating (just) tags doesn't return 'changed' - # - tag_table is changed - - '"hash_key_name" in tag_table' - - '"hash_key_type" in tag_table' - - '"indexes" in tag_table' - - '"range_key_name" in tag_table' - - '"range_key_type" in tag_table' - - '"read_capacity" in tag_table' - - '"region" in tag_table' - - '"table_name" in tag_table' - - '"table_status" in tag_table' - - '"write_capacity" in tag_table' - # XXX Bug - returns none when not actively set - # - tag_table.hash_key_name == table_index - # XXX Bug - returns string when not actively set - #- tag_table.hash_key_type == table_index_type - - tag_table.indexes | length == 0 - - tag_table.range_key_name is none - - tag_table.range_key_type == "STRING" - - tag_table.read_capacity == 1 - - tag_table.table_name == table_name - - tag_table.write_capacity == 1 - - tag_table.tags == tags_default - - - name: Tag table - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - check_mode: True - - - name: Check results - Tag table - idempotent - check_mode - assert: - that: - - tag_table is successful - - tag_table is not changed - - - name: Tag table - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - tags: '{{ tags_default }}' - register: tag_table - - - name: Check results - Tag table - idempotent - assert: - that: - - tag_table is successful - - tag_table is not changed - - '"hash_key_name" in tag_table' - - '"hash_key_type" in tag_table' - - '"indexes" in tag_table' - - '"range_key_name" in tag_table' - - '"range_key_type" in tag_table' - - '"read_capacity" in tag_table' - - '"region" in tag_table' - - '"table_name" in tag_table' - - '"table_status" in tag_table' - - '"write_capacity" in tag_table' - # XXX Bug - returns none when not actively set - # - tag_table.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - tag_table.hash_key_type == table_index_type - - tag_table.indexes | length == 0 - - tag_table.range_key_name is none - - tag_table.range_key_type == "STRING" - - tag_table.read_capacity == 1 - - tag_table.table_name == table_name - - tag_table.write_capacity == 1 - - tag_table.tags == tags_default - - # ============================================== - - - name: Update table read capacity - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - check_mode: True - - - name: Check results - Update table read capacity - check_mode - assert: - that: - - update_read is successful - - update_read is changed - - - name: Update table read capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - - - name: Check results - Update table read capacity - assert: - that: - - update_read is successful - - update_read is changed - - '"hash_key_name" in update_read' - - '"hash_key_type" in update_read' - - '"indexes" in update_read' - - '"range_key_name" in update_read' - - '"range_key_type" in update_read' - - '"read_capacity" in update_read' - - '"region" in update_read' - - '"table_name" in update_read' - - '"table_status" in update_read' - - '"write_capacity" in update_read' - # XXX Bug - returns none when not actively set - # - update_read.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_read.hash_key_type == table_index_type - - update_read.indexes | length == 0 - - update_read.range_key_name is none - - update_read.range_key_type == "STRING" - - update_read.read_capacity == 3 - - update_read.table_name == table_name - - update_read.write_capacity == 1 - # Tags are only returned when tagging - # - update_read.tags == tags_default - - - name: Update table read capacity - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - check_mode: True - - - name: Check results - Update table read capacity - idempotent - check_mode - assert: - that: - - update_read is successful - # XXX Bug - returns changed - # - update_read is not changed - - - name: Update table read capacity - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - read_capacity: 3 - register: update_read - # Can result in ResourceInUseException - change in flight - until: update_read is successful - retries: 15 - delay: 10 - - - name: Check results - Update table read capacity - idempotent - assert: - that: - - update_read is successful - - update_read is not changed - - '"hash_key_name" in update_read' - - '"hash_key_type" in update_read' - - '"indexes" in update_read' - - '"range_key_name" in update_read' - - '"range_key_type" in update_read' - - '"read_capacity" in update_read' - - '"region" in update_read' - - '"table_name" in update_read' - - '"table_status" in update_read' - - '"write_capacity" in update_read' - # XXX Bug - returns none when not actively set - # - update_read.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_read.hash_key_type == table_index_type - - update_read.indexes | length == 0 - - update_read.range_key_name is none - - update_read.range_key_type == "STRING" - - update_read.read_capacity == 3 - - update_read.table_name == table_name - - update_read.write_capacity == 1 - # Tags are only returned when tagging - # - update_read.tags == tags_default - - # ============================================== - - - name: Update table write capacity - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - check_mode: True - - - name: Check results - Update table write capacity - check_mode - assert: - that: - - update_write is successful - - update_write is changed - - - name: Update table write capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - - - name: Check results - Update table write capacity - assert: - that: - - update_write is successful - - update_write is changed - - '"hash_key_name" in update_write' - - '"hash_key_type" in update_write' - - '"indexes" in update_write' - - '"range_key_name" in update_write' - - '"range_key_type" in update_write' - - '"read_capacity" in update_write' - - '"region" in update_write' - - '"table_name" in update_write' - - '"table_status" in update_write' - - '"write_capacity" in update_write' - # XXX Bug - returns none when not actively set - # - update_write.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_write.hash_key_type == table_index_type - - update_write.indexes | length == 0 - - update_write.range_key_name is none - - update_write.range_key_type == "STRING" - # XXX Bug - gets reset to 1 because a default was set - # - update_write.read_capacity == 3 - - update_write.table_name == table_name - - update_write.write_capacity == 3 - # Tags are only returned when tagging - # - update_write.tags == tags_default - - - name: Update table write capacity - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - check_mode: True - - - name: Check results - Update table write capacity - idempotent - check_mode - assert: - that: - - update_write is successful - # XXX Bug - returns changed - # - update_write is not changed - - - name: Update table write capacity - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - write_capacity: 3 - register: update_write - # Can result in ResourceInUseException - change in flight - until: update_write is successful - retries: 15 - delay: 10 - - - name: Check results - Update table write capacity - idempotent - assert: - that: - - update_write is successful - # XXX Bug - returns changed - # - update_write is not changed - - '"hash_key_name" in update_write' - - '"hash_key_type" in update_write' - - '"indexes" in update_write' - - '"range_key_name" in update_write' - - '"range_key_type" in update_write' - - '"read_capacity" in update_write' - - '"region" in update_write' - - '"table_name" in update_write' - - '"table_status" in update_write' - - '"write_capacity" in update_write' - # XXX Bug - returns none when not actively set - # - update_write.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_write.hash_key_type == table_index_type - - update_write.indexes | length == 0 - - update_write.range_key_name is none - - update_write.range_key_type == "STRING" - # XXX Bug - gets reset to 1 because a default was set - # - update_write.read_capacity == 3 - - update_write.table_name == table_name - - update_write.write_capacity == 3 - # Tags are only returned when tagging - # - update_write.tags == tags_default - - # ============================================== - - - name: Update table add range index - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - check_mode: True - - - name: Check results - Update table add range index - check_mode - assert: - that: - - update_range_index is successful - - update_range_index is changed - - - name: Update table write capacity - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - - - name: Check results - Update table add range index - assert: - that: - - update_range_index is successful - - update_range_index is changed - - '"hash_key_name" in update_range_index' - - '"hash_key_type" in update_range_index' - - '"indexes" in update_range_index' - - '"range_key_name" in update_range_index' - - '"range_key_type" in update_range_index' - - '"read_capacity" in update_range_index' - - '"region" in update_range_index' - - '"table_name" in update_range_index' - - '"table_status" in update_range_index' - - '"write_capacity" in update_range_index' - # XXX Bug - returns none when not actively set - # - update_range_index.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_range_index.hash_key_type == table_index_type - - update_range_index.indexes | length == 0 - - update_range_index.range_key_name == range_index - - update_range_index.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.read_capacity == 3 - - update_range_index.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.write_capacity == 3 - # Tags are only returned when tagging - # - update_range_index.tags == tags_default - - - name: Update table add range index - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - check_mode: True - - - name: Check results - Update table add range index - idempotent - check_mode - assert: - that: - - update_range_index is successful - # XXX Bug - returns changed - # - update_range_index is not changed - - - name: Update table add range index - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - range_key_name: '{{ range_index }}' - range_key_type: '{{ range_index_type }}' - register: update_range_index - # Can result in ResourceInUseException - change in flight - until: update_range_index is successful - retries: 15 - delay: 10 - - - name: Check results - Update table add range index - idempotent - assert: - that: - - update_range_index is successful - # XXX Bug - returns changed - # - update_range_index is not changed - - '"hash_key_name" in update_range_index' - - '"hash_key_type" in update_range_index' - - '"indexes" in update_range_index' - - '"range_key_name" in update_range_index' - - '"range_key_type" in update_range_index' - - '"read_capacity" in update_range_index' - - '"region" in update_range_index' - - '"table_name" in update_range_index' - - '"table_status" in update_range_index' - - '"write_capacity" in update_range_index' - # XXX Bug - returns none when not actively set - # - update_range_index.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_range_index.hash_key_type == table_index_type - - update_range_index.indexes | length == 0 - - update_range_index.range_key_name == range_index - - update_range_index.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.read_capacity == 3 - - update_range_index.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_range_index.write_capacity == 3 - # Tags are only returned when tagging - # - update_range_index.tags == tags_default - - # ============================================== - - - name: Update table add indexes - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - check_mode: True - - - name: Check results - Update table add indexes - check_mode - assert: - that: - - update_indexes is successful - - update_indexes is changed - - - name: Update table add indexes - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - # Can result in LimitExceededException - change in flight - until: update_indexes is successful - retries: 45 - delay: 10 - - - name: Check results - Update table add indexes - assert: - that: - - update_indexes is successful - - update_indexes is changed - - '"hash_key_name" in update_indexes' - - '"hash_key_type" in update_indexes' - - '"indexes" in update_indexes' - - '"range_key_name" in update_indexes' - - '"range_key_type" in update_indexes' - - '"read_capacity" in update_indexes' - - '"region" in update_indexes' - - '"table_name" in update_indexes' - - '"table_status" in update_indexes' - - '"write_capacity" in update_indexes' - # XXX Bug - returns none when not actively set - # - update_indexes.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_indexes.hash_key_type == table_index_type - - update_indexes.indexes | length == 2 - # XXX Bug - returns none when not actively set - # - update_indexes.range_key_name == range_index - # XXX Bug - returns string when not actively set - # - update_indexes.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.read_capacity == 3 - - update_indexes.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.write_capacity == 3 - # Tags are only returned when tagging - # - update_indexes.tags == tags_default - - - name: Update table add indexes - idempotent - check_mode - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - check_mode: True - - - name: Check results - Update table add indexes - idempotent - check_mode - assert: - that: - - update_indexes is successful - # XXX Bug - returns changed - # - update_indexes is not changed - - - name: Update table add indexes - idempotent - dynamodb_table: - state: present - name: '{{ table_name }}' - indexes: '{{ indexes }}' - register: update_indexes - # Can result in LimitExceededException - change in flight - until: update_indexes is successful - retries: 45 - delay: 10 - - - name: Check results - Update table add indexes - idempotent - assert: - that: - - update_indexes is successful - # XXX Bug - returns changed - # - update_indexes is not changed - - '"hash_key_name" in update_indexes' - - '"hash_key_type" in update_indexes' - - '"indexes" in update_indexes' - - '"range_key_name" in update_indexes' - - '"range_key_type" in update_indexes' - - '"read_capacity" in update_indexes' - - '"region" in update_indexes' - - '"table_name" in update_indexes' - - '"table_status" in update_indexes' - - '"write_capacity" in update_indexes' - # XXX Bug - returns none when not actively set - # - update_indexes.hash_key_name == table_index - # XXX Bug - returns string when not actively set - # - update_indexes.hash_key_type == table_index_type - - update_indexes.indexes | length == 2 - # XXX Bug - returns none when not actively set - # - update_indexes.range_key_name == range_index - # XXX Bug - returns string when not actively set - # - update_indexes.range_key_type == range_index_type - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.read_capacity == 3 - - update_indexes.table_name == table_name - # XXX Bug - gets reset to 1 because a default was set - # - update_indexes.write_capacity == 3 - # Tags are only returned when tagging - # - update_indexes.tags == tags_default - - # ============================================== - - - name: Delete table - check_mode - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - check_mode: True - - - name: Check results - Delete table - check_mode - assert: - that: - - delete_table is successful - - delete_table is changed - - - name: Delete table - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Updates don't support waiting yet, so retry until successful - until: delete_table is successful - retries: 45 - delay: 10 - - - name: Check results - Delete table - assert: - that: - - delete_table is successful - - delete_table is changed - - - name: Delete table - idempotent - check_mode - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - check_mode: True - - - name: Check results - Delete table - idempotent - check_mode - assert: - that: - - delete_table is successful - # XXX bug - returns changed - # - delete_table is not changed - - - name: Delete table - idempotent - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Deletion doesn't support waiting yet, so retry until successful - until: delete_table is successful - retries: 45 - delay: 10 - - - name: Check results - Delete table - idempotent - assert: - that: - - delete_table is successful - - delete_table is not changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Clean up table - dynamodb_table: - state: absent - name: '{{ table_name }}' - register: delete_table - # Can result in LimitExceededException or ResourceInUseException - changes in flight - until: delete_table is successful - retries: 40 - delay: 10 diff --git a/tests/integration/targets/ec2_eip/tasks/main.yml b/tests/integration/targets/ec2_eip/tasks/main.yml index 9f03f5b5647..83093572697 100644 --- a/tests/integration/targets/ec2_eip/tasks/main.yml +++ b/tests/integration/targets/ec2_eip/tasks/main.yml @@ -662,25 +662,6 @@ state: absent name: '{{ resource_prefix }}-vpc' cidr_block: '{{ vpc_cidr }}' - - - name: Create an EIP outside a VPC - ec2_eip: - state: present - in_vpc: '{{ omit }}' - register: unbound_eip - - assert: - that: - - unbound_eip is successful - - unbound_eip is changed - - name: Release EIP - ec2_eip: - state: absent - public_ip: '{{ unbound_eip.public_ip }}' - register: release_unbound_eip - - assert: - that: - - release_unbound_eip is successful - - release_unbound_eip is changed # ===================================================== always: - name: Cleanup instance (by id) @@ -754,12 +735,6 @@ public_ip: '{{ no_tagged_eip.public_ip }}' when: no_tagged_eip is changed ignore_errors: true - - name: Cleanup unbound_eip - ec2_eip: - state: absent - public_ip: '{{ unbound_eip.public_ip }}' - when: unbound_eip is changed - ignore_errors: true - name: Cleanup VPC ec2_vpc_net: state: absent diff --git a/tests/integration/targets/elasticache/aliases b/tests/integration/targets/elasticache/aliases index 5ee1d22add8..88ef7754817 100644 --- a/tests/integration/targets/elasticache/aliases +++ b/tests/integration/targets/elasticache/aliases @@ -3,3 +3,5 @@ unstable cloud/aws + +elasticache_subnet_group diff --git a/tests/integration/targets/elasticache_subnet_group/aliases b/tests/integration/targets/elasticache_subnet_group/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/elasticache_subnet_group/defaults/main.yml b/tests/integration/targets/elasticache_subnet_group/defaults/main.yml deleted file mode 100644 index ea8921880a9..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/defaults/main.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- -availability_zone: '{{ ec2_availability_zone_names[0] }}' - -vpc_name: '{{ resource_prefix }}' -subnet_name_a: '{{ resource_prefix }}-a' -subnet_name_b: '{{ resource_prefix }}-b' -subnet_name_c: '{{ resource_prefix }}-c' -subnet_name_d: '{{ resource_prefix }}-d' - -vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' -subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' -subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' -subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' -subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' - -subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' -subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' - -group_name: '{{ resource_prefix }}' -description_default: 'Subnet Description' -description_updated: 'updated subnet description' - -# Tagging not currently supported, planned with boto3 upgrade -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/elasticache_subnet_group/meta/main.yml b/tests/integration/targets/elasticache_subnet_group/meta/main.yml deleted file mode 100644 index 930e8622824..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_ec2_facts diff --git a/tests/integration/targets/elasticache_subnet_group/tasks/main.yml b/tests/integration/targets/elasticache_subnet_group/tasks/main.yml deleted file mode 100644 index 5814f9dc90d..00000000000 --- a/tests/integration/targets/elasticache_subnet_group/tasks/main.yml +++ /dev/null @@ -1,681 +0,0 @@ ---- -# elasticache_subnet_group integration tests -# -# Current module limitations: -# - check_mode not supported -# - Tagging not supported -# - Returned values *very* limited (almost none) -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================================ - - - name: Create Subnet Group with no subnets - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - check_mode: True - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - check_mode - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateCacheSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"SubnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - - name: Create Subnet Group with no subnets - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateCacheSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"SubnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - # ============================================================ - # Setup infra needed for tests - - name: create a VPC - ec2_vpc_net: - state: present - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - tags: - TestPrefix: '{{ resource_prefix }}' - register: vpc_result - - - name: create subnets - ec2_vpc_subnet: - state: present - cidr: '{{ item.cidr }}' - az: '{{ item.zone }}' - vpc_id: '{{ vpc_result.vpc.id }}' - tags: - Name: '{{ item.name }}' - TestPrefix: '{{ resource_prefix }}' - register: vpc_subnet_create - loop: - - name: '{{ subnet_name_a }}' - cidr: '{{ subnet_cidr_a }}' - zone: '{{ subnet_zone_a }}' - - name: '{{ subnet_name_b }}' - cidr: '{{ subnet_cidr_b }}' - zone: '{{ subnet_zone_b }}' - - name: '{{ subnet_name_c }}' - cidr: '{{ subnet_cidr_c }}' - zone: '{{ subnet_zone_c }}' - - name: '{{ subnet_name_d }}' - cidr: '{{ subnet_cidr_d }}' - zone: '{{ subnet_zone_d }}' - - - name: Store IDs of subnets and VPC - set_fact: - vpc_id: '{{ vpc_result.vpc.id }}' - subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' - subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' - subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' - subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' - - # ============================================================ - - - name: Create Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: create_group - - - name: Check result - Create Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == description_default - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - - name: Create Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: create_group - - - name: Check result - Create Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_default }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == description_default - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Update Subnet Group Description - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - check_mode: True - register: update_description - - - name: Check result - Update Subnet Group Description - check_mode - assert: - that: - - update_description is successful - - update_description is changed - - - name: Update Subnet Group Description - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - assert: - that: - - update_description is successful - - update_description is changed - - '"cache_subnet_group" in update_description' - - '"arn" in update_description.cache_subnet_group' - - '"description" in update_description.cache_subnet_group' - - '"name" in update_description.cache_subnet_group' - - '"subnet_ids" in update_description.cache_subnet_group' - - '"vpc_id" in update_description.cache_subnet_group' - - update_description.cache_subnet_group.description == description_updated - - update_description.cache_subnet_group.name == group_name - - subnet_id_a in update_description.cache_subnet_group.subnet_ids - - subnet_id_b in update_description.cache_subnet_group.subnet_ids - - subnet_id_c not in update_description.cache_subnet_group.subnet_ids - - subnet_id_d not in update_description.cache_subnet_group.subnet_ids - - update_description.cache_subnet_group.vpc_id == vpc_id - - update_description.cache_subnet_group.arn.startswith('arn:') - - update_description.cache_subnet_group.arn.endswith(group_name) - - - name: Update Subnet Group Description - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - check_mode: True - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - check_mode - assert: - that: - - update_description is successful - - update_description is not changed - - - name: Update Subnet Group Description - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - ## No longer mandatory - # subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - assert: - that: - - update_description is successful - - update_description is not changed - - '"cache_subnet_group" in update_description' - - '"arn" in update_description.cache_subnet_group' - - '"description" in update_description.cache_subnet_group' - - '"name" in update_description.cache_subnet_group' - - '"subnet_ids" in update_description.cache_subnet_group' - - '"vpc_id" in update_description.cache_subnet_group' - - update_description.cache_subnet_group.description == description_updated - - update_description.cache_subnet_group.name == group_name - - subnet_id_a in update_description.cache_subnet_group.subnet_ids - - subnet_id_b in update_description.cache_subnet_group.subnet_ids - - subnet_id_c not in update_description.cache_subnet_group.subnet_ids - - subnet_id_d not in update_description.cache_subnet_group.subnet_ids - - update_description.cache_subnet_group.vpc_id == vpc_id - - update_description.cache_subnet_group.arn.startswith('arn:') - - update_description.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Update Subnet Group subnets - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - check_mode: True - register: update_subnets - - - name: Check result - Update Subnet Group subnets - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is changed - - - name: Update Subnet Group subnets - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - assert: - that: - - update_subnets is successful - - update_subnets is changed - - '"cache_subnet_group" in update_subnets' - - '"arn" in update_subnets.cache_subnet_group' - - '"description" in update_subnets.cache_subnet_group' - - '"name" in update_subnets.cache_subnet_group' - - '"subnet_ids" in update_subnets.cache_subnet_group' - - '"vpc_id" in update_subnets.cache_subnet_group' - - update_subnets.cache_subnet_group.description == description_updated - - update_subnets.cache_subnet_group.name == group_name - - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids - - update_subnets.cache_subnet_group.vpc_id == vpc_id - - update_subnets.cache_subnet_group.arn.startswith('arn:') - - update_subnets.cache_subnet_group.arn.endswith(group_name) - - - name: Update Subnet Group subnets - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - check_mode: True - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - - name: Update Subnet Group subnets - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - ## No longer mandatory - # description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - '"cache_subnet_group" in update_subnets' - - '"arn" in update_subnets.cache_subnet_group' - - '"description" in update_subnets.cache_subnet_group' - - '"name" in update_subnets.cache_subnet_group' - - '"subnet_ids" in update_subnets.cache_subnet_group' - - '"vpc_id" in update_subnets.cache_subnet_group' - - update_subnets.cache_subnet_group.description == description_updated - - update_subnets.cache_subnet_group.name == group_name - - subnet_id_a not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cache_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cache_subnet_group.subnet_ids - - update_subnets.cache_subnet_group.vpc_id == vpc_id - - update_subnets.cache_subnet_group.arn.startswith('arn:') - - update_subnets.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Delete Subnet Group - check_mode - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - check_mode: True - register: delete_group - - - name: Check result - Delete Subnet Group - check_mode - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - check_mode: True - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - check_mode - assert: - that: - - delete_group is not changed - - - name: Delete Subnet Group - idempotency - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - assert: - that: - - delete_group is not changed - - # ============================================================ - - - name: Create minimal Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - check_mode: True - register: create_group - - - name: Check result - Create minimal Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create minimal Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == group_name - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b not in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - - name: Create minimal Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - check_mode: True - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create minimal Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"cache_subnet_group" in create_group' - - '"arn" in create_group.cache_subnet_group' - - '"description" in create_group.cache_subnet_group' - - '"name" in create_group.cache_subnet_group' - - '"subnet_ids" in create_group.cache_subnet_group' - - '"vpc_id" in create_group.cache_subnet_group' - - create_group.cache_subnet_group.description == group_name - - create_group.cache_subnet_group.name == group_name - - subnet_id_a in create_group.cache_subnet_group.subnet_ids - - subnet_id_b not in create_group.cache_subnet_group.subnet_ids - - subnet_id_c not in create_group.cache_subnet_group.subnet_ids - - subnet_id_d not in create_group.cache_subnet_group.subnet_ids - - create_group.cache_subnet_group.vpc_id == vpc_id - - create_group.cache_subnet_group.arn.startswith('arn:') - - create_group.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Full Update Subnet Group - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: update_complex - - - name: Check result - Full Update Subnet Group - check_mode - assert: - that: - - update_complex is successful - - update_complex is changed - - - name: Update Subnet Group - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - assert: - that: - - update_complex is successful - - update_complex is changed - - '"cache_subnet_group" in update_complex' - - '"arn" in update_complex.cache_subnet_group' - - '"description" in update_complex.cache_subnet_group' - - '"name" in update_complex.cache_subnet_group' - - '"subnet_ids" in update_complex.cache_subnet_group' - - '"vpc_id" in update_complex.cache_subnet_group' - - update_complex.cache_subnet_group.description == description_updated - - update_complex.cache_subnet_group.name == group_name - - subnet_id_a in update_complex.cache_subnet_group.subnet_ids - - subnet_id_b in update_complex.cache_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids - - update_complex.cache_subnet_group.vpc_id == vpc_id - - update_complex.cache_subnet_group.arn.startswith('arn:') - - update_complex.cache_subnet_group.arn.endswith(group_name) - - - name: Full Update Subnet Group - idempotency - check_mode - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - check_mode: True - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - check_mode - assert: - that: - - update_complex is successful - - update_complex is not changed - - - name: Full Update Subnet Group - idempotency - elasticache_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - assert: - that: - - update_complex is successful - - update_complex is not changed - - '"cache_subnet_group" in update_complex' - - '"arn" in update_complex.cache_subnet_group' - - '"description" in update_complex.cache_subnet_group' - - '"name" in update_complex.cache_subnet_group' - - '"subnet_ids" in update_complex.cache_subnet_group' - - '"vpc_id" in update_complex.cache_subnet_group' - - update_complex.cache_subnet_group.description == description_updated - - update_complex.cache_subnet_group.name == group_name - - subnet_id_a in update_complex.cache_subnet_group.subnet_ids - - subnet_id_b in update_complex.cache_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cache_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cache_subnet_group.subnet_ids - - update_complex.cache_subnet_group.vpc_id == vpc_id - - update_complex.cache_subnet_group.arn.startswith('arn:') - - update_complex.cache_subnet_group.arn.endswith(group_name) - - # ============================================================ - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Delete Subnet Group - elasticache_subnet_group: - state: absent - name: '{{ group_name }}' - ignore_errors: True - - - name: tidy up subnet - ec2_vpc_subnet: - state: absent - cidr: '{{ item }}' - vpc_id: '{{ vpc_result.vpc.id }}' - loop: - - '{{ subnet_cidr_a }}' - - '{{ subnet_cidr_b }}' - - '{{ subnet_cidr_c }}' - - '{{ subnet_cidr_d }}' - ignore_errors: True - - - name: tidy up VPC - ec2_vpc_net: - state: absent - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - ignore_errors: True diff --git a/tests/integration/targets/elb_target/tasks/ec2_target.yml b/tests/integration/targets/elb_target/tasks/ec2_target.yml index f350672cafe..108ffa4d30b 100644 --- a/tests/integration/targets/elb_target/tasks/ec2_target.yml +++ b/tests/integration/targets/elb_target/tasks/ec2_target.yml @@ -17,6 +17,7 @@ - set_fact: ec2_ami_image: '{{ ec2_amis.images[0].image_id }}' + - name: set up testing VPC ec2_vpc_net: name: "{{ resource_prefix }}-vpc" @@ -118,33 +119,6 @@ tags: Description: "Created by {{ resource_prefix }}" - - name: set up testing target group for NLB (type=instance) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: set up testing target group for NLB (type=instance) - assert: - that: - - result.changed - - '"health_check_port" in result' - - result.port == 80 - - '"health_check_protocol" in result' - - result.health_check_protocol == 'TCP' - - '"tags" in result' - - '"target_group_arn" in result' - - result.target_group_name == "{{ tg_name }}-nlb" - - result.target_type == 'instance' - - result.vpc_id == '{{ vpc.vpc.id }}' - - name: set up ec2 instance to use as a target ec2_instance: name: "{{ resource_prefix }}-inst" @@ -187,98 +161,6 @@ TargetGroupName: "{{ tg_name }}-used" state: present - - name: create a network load balancer - elb_network_lb: - name: "{{ lb_name }}-nlb" - subnets: - - "{{ subnet_1.subnet.id }}" - - "{{ subnet_2.subnet.id }}" - listeners: - - Protocol: TCP - Port: 80 - DefaultActions: - - Type: forward - TargetGroupName: "{{ tg_name }}-nlb" - state: present - register: result - - - name: create a netwok load balancer - assert: - that: - - result.changed - - '"created_time" in result' - - '"load_balancer_arn" in result' - - '"tags" in result' - - result.type == 'network' - - result.vpc_id == '{{ vpc.vpc.id }}' - - - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - preserve_client_ip_enabled: false - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: modify up testing target group for NLB (preserve_client_ip_enabled=false) - assert: - that: - - result.changed - - result.preserve_client_ip_enabled == 'false' - - result.proxy_protocol_v2_enabled == 'false' - - - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - proxy_protocol_v2_enabled: true - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: modify up testing target group for NLB (proxy_protocol_v2_enabled=true) - assert: - that: - - result.changed - - result.proxy_protocol_v2_enabled == 'true' - - result.preserve_client_ip_enabled == 'false' - - - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) - elb_target_group: - name: "{{ tg_name }}-nlb" - health_check_port: 80 - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: present - target_type: instance - modify_targets: true - preserve_client_ip_enabled: false - proxy_protocol_v2_enabled: true - tags: - Description: "Created by {{ resource_prefix }}" - register: result - - - name: (idempotence) modify up testing target group for NLB (preserve_client_ip_enabled=false and proxy_protocol_v2_enabled=true) - assert: - that: - - not result.changed - - result.proxy_protocol_v2_enabled == 'true' - - result.preserve_client_ip_enabled == 'false' - # ============================================================ - name: @@ -481,26 +363,6 @@ - "{{ tg_tcpudp_name }}" ignore_errors: true - - name: remove tcp testing target groups - elb_target_group: - name: "{{ item }}" - protocol: tcp - port: 80 - vpc_id: '{{ vpc.vpc.id }}' - state: absent - target_type: instance - tags: - Description: "Created by {{ resource_prefix }}" - Protocol: "UDP" - wait: true - wait_timeout: 400 - register: removed - retries: 10 - until: removed is not failed - with_items: - - "{{ tg_name }}-nlb" - ignore_errors: true - - name: remove application load balancer elb_application_lb: name: "{{ lb_name }}" @@ -523,26 +385,6 @@ until: removed is not failed ignore_errors: true - - name: remove network load balancer - elb_network_lb: - name: "{{ lb_name }}-nlb" - subnets: - - "{{ subnet_1.subnet.id }}" - - "{{ subnet_2.subnet.id }}" - listeners: - - Protocol: TCP - Port: 80 - DefaultActions: - - Type: forward - TargetGroupName: "{{ tg_name }}-nlb" - state: absent - wait: true - wait_timeout: 400 - register: removed - retries: 10 - until: removed is not failed - ignore_errors: true - - name: remove testing security group ec2_group: state: absent diff --git a/tests/integration/targets/iam_server_certificate/aliases b/tests/integration/targets/iam_server_certificate/aliases deleted file mode 100644 index 98e604ec4b3..00000000000 --- a/tests/integration/targets/iam_server_certificate/aliases +++ /dev/null @@ -1,3 +0,0 @@ -cloud/aws - -iam_server_certificate_info diff --git a/tests/integration/targets/iam_server_certificate/defaults/main.yml b/tests/integration/targets/iam_server_certificate/defaults/main.yml deleted file mode 100644 index ed97d539c09..00000000000 --- a/tests/integration/targets/iam_server_certificate/defaults/main.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/tests/integration/targets/iam_server_certificate/meta/main.yml b/tests/integration/targets/iam_server_certificate/meta/main.yml deleted file mode 100644 index cb6005d042c..00000000000 --- a/tests/integration/targets/iam_server_certificate/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_remote_tmp_dir diff --git a/tests/integration/targets/iam_server_certificate/tasks/main.yml b/tests/integration/targets/iam_server_certificate/tasks/main.yml deleted file mode 100644 index f0c6946728a..00000000000 --- a/tests/integration/targets/iam_server_certificate/tasks/main.yml +++ /dev/null @@ -1,34 +0,0 @@ ---- -# iam_server_certificate integration tests -# -# Current module limitations: -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - # Check that the alias works - - iam_cert: {} - ignore_errors: true - register: iam_cert_alias - - - iam_server_certificate: {} - ignore_errors: true - register: no_args - - - assert: - that: - - iam_cert_alias is failed - - no_args is failed - - no_args.msg == iam_cert_alias.msg - - no_args.msg.startswith('missing required arguments') - - always: - - debug: msg=test - - ################################################ - # TEARDOWN STARTS HERE - ################################################ diff --git a/tests/integration/targets/redshift_subnet_group/aliases b/tests/integration/targets/redshift_subnet_group/aliases deleted file mode 100644 index 4ef4b2067d0..00000000000 --- a/tests/integration/targets/redshift_subnet_group/aliases +++ /dev/null @@ -1 +0,0 @@ -cloud/aws diff --git a/tests/integration/targets/redshift_subnet_group/defaults/main.yml b/tests/integration/targets/redshift_subnet_group/defaults/main.yml deleted file mode 100644 index ea8921880a9..00000000000 --- a/tests/integration/targets/redshift_subnet_group/defaults/main.yml +++ /dev/null @@ -1,42 +0,0 @@ ---- -availability_zone: '{{ ec2_availability_zone_names[0] }}' - -vpc_name: '{{ resource_prefix }}' -subnet_name_a: '{{ resource_prefix }}-a' -subnet_name_b: '{{ resource_prefix }}-b' -subnet_name_c: '{{ resource_prefix }}-c' -subnet_name_d: '{{ resource_prefix }}-d' - -vpc_cidr: '10.{{ 256 | random(seed=resource_prefix) }}.0.0/16' -subnet_cidr_a: '10.{{ 256 | random(seed=resource_prefix) }}.1.0/24' -subnet_cidr_b: '10.{{ 256 | random(seed=resource_prefix) }}.2.0/24' -subnet_cidr_c: '10.{{ 256 | random(seed=resource_prefix) }}.3.0/24' -subnet_cidr_d: '10.{{ 256 | random(seed=resource_prefix) }}.4.0/24' - -subnet_zone_a: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_b: '{{ ec2_availability_zone_names[1] }}' -subnet_zone_c: '{{ ec2_availability_zone_names[0] }}' -subnet_zone_d: '{{ ec2_availability_zone_names[1] }}' - -group_name: '{{ resource_prefix }}' -description_default: 'Subnet Description' -description_updated: 'updated subnet description' - -# Tagging not currently supported, planned with boto3 upgrade -tags_default: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - PascalCaseKey: PascalCaseValue - 'key with spaces': value with spaces - 'Upper With Spaces': Upper With Spaces - -partial_tags: - snake_case_key: snake_case_value - camelCaseKey: camelCaseValue - -updated_tags: - updated_snake_case_key: updated_snake_case_value - updatedCamelCaseKey: updatedCamelCaseValue - UpdatedPascalCaseKey: UpdatedPascalCaseValue - 'updated key with spaces': updated value with spaces - 'updated Upper With Spaces': Updated Upper With Spaces diff --git a/tests/integration/targets/redshift_subnet_group/meta/main.yml b/tests/integration/targets/redshift_subnet_group/meta/main.yml deleted file mode 100644 index 930e8622824..00000000000 --- a/tests/integration/targets/redshift_subnet_group/meta/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -dependencies: - - prepare_tests - - setup_ec2_facts diff --git a/tests/integration/targets/redshift_subnet_group/tasks/main.yml b/tests/integration/targets/redshift_subnet_group/tasks/main.yml deleted file mode 100644 index e15ee9b9313..00000000000 --- a/tests/integration/targets/redshift_subnet_group/tasks/main.yml +++ /dev/null @@ -1,692 +0,0 @@ ---- -# redshift_subnet_group integration tests -# -# Current module limitations: -# - check_mode not supported -# - Tagging not supported -# - Module is not idempotent -# - Returned values *very* limited -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - block: - - # ============================================================ - - - name: Create Subnet Group with no subnets - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - check_mode: True - - - name: Check result - Create Subnet Group with no subnets - check_mode - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateClusterSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"subnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - - name: Create Subnet Group with no subnets - redshift_subnet_group: - state: present - name: '{{ group_name }}' - register: create_group - ignore_errors: True - - - name: Check result - Create Subnet Group with no subnets - assert: - that: - - create_group is failed - # Check we caught the issue before trying to create - - '"CreateClusterSubnetGroup" not in create_group.resource_actions' - # Check that we don't refer to the boto3 parameter - - '"subnetIds" not in create_group.msg' - # Loosely check the message - - '"subnet" in create_group.msg' - - '"At least" in create_group.msg' - - # ============================================================ - # Setup infra needed for tests - - name: create a VPC - ec2_vpc_net: - state: present - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - tags: - TestPrefix: '{{ resource_prefix }}' - register: vpc_result - - - name: create subnets - ec2_vpc_subnet: - state: present - cidr: '{{ item.cidr }}' - az: '{{ item.zone }}' - vpc_id: '{{ vpc_result.vpc.id }}' - tags: - Name: '{{ item.name }}' - TestPrefix: '{{ resource_prefix }}' - register: vpc_subnet_create - loop: - - name: '{{ subnet_name_a }}' - cidr: '{{ subnet_cidr_a }}' - zone: '{{ subnet_zone_a }}' - - name: '{{ subnet_name_b }}' - cidr: '{{ subnet_cidr_b }}' - zone: '{{ subnet_zone_b }}' - - name: '{{ subnet_name_c }}' - cidr: '{{ subnet_cidr_c }}' - zone: '{{ subnet_zone_c }}' - - name: '{{ subnet_name_d }}' - cidr: '{{ subnet_cidr_d }}' - zone: '{{ subnet_zone_d }}' - - - name: Store IDs of subnets and VPC - set_fact: - vpc_id: '{{ vpc_result.vpc.id }}' - subnet_id_a: '{{ vpc_subnet_create.results[0].subnet.id }}' - subnet_id_b: '{{ vpc_subnet_create.results[1].subnet.id }}' - subnet_id_c: '{{ vpc_subnet_create.results[2].subnet.id }}' - subnet_id_d: '{{ vpc_subnet_create.results[3].subnet.id }}' - - # ============================================================ - - - name: Create Subnet Group - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - check_mode: True - - - name: Check result - Create Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create Subnet Group - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == description_default - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - - name: Create Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - check_mode: True - - - name: Check result - Create Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create Subnet Group - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_default }}' - group_subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: create_group - - - name: Check result - Create Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == description_default - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Update Subnet Group Description - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - check_mode: True - - - name: Check result - Update Subnet Group Description - check_mode - assert: - that: - - update_description is successful - - update_description is changed - - - name: Update Subnet Group Description - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - assert: - that: - - update_description is successful - - update_description is changed - - '"group" in update_description' - - '"name" in update_description.group' - - '"vpc_id" in update_description.group' - - update_description.group.name == group_name - - update_description.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_description' - - '"description" in update_description.cluster_subnet_group' - - '"subnet_ids" in update_description.cluster_subnet_group' - - '"vpc_id" in update_description.cluster_subnet_group' - - update_description.cluster_subnet_group.name == group_name - - update_description.cluster_subnet_group.description == description_updated - - subnet_id_a in update_description.cluster_subnet_group.subnet_ids - - subnet_id_b in update_description.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids - - update_description.cluster_subnet_group.vpc_id == vpc_id - - - name: Update Subnet Group Description - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - check_mode: True - - - name: Check result - Update Subnet Group Description - idempotency - check_mode - assert: - that: - - update_description is successful - - update_description is not changed - - - name: Update Subnet Group Description - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - group_description: '{{ description_updated }}' - ## No longer mandatory - # group_subnets: - # - '{{ subnet_id_a }}' - # - '{{ subnet_id_b }}' - register: update_description - - - name: Check result - Update Subnet Group Description - idempotency - assert: - that: - - update_description is successful - - update_description is not changed - - '"group" in update_description' - - '"name" in update_description.group' - - '"vpc_id" in update_description.group' - - update_description.group.name == group_name - - update_description.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_description' - - '"description" in update_description.cluster_subnet_group' - - '"subnet_ids" in update_description.cluster_subnet_group' - - '"vpc_id" in update_description.cluster_subnet_group' - - update_description.cluster_subnet_group.name == group_name - - update_description.cluster_subnet_group.description == description_updated - - subnet_id_a in update_description.cluster_subnet_group.subnet_ids - - subnet_id_b in update_description.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_description.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_description.cluster_subnet_group.subnet_ids - - update_description.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Update Subnet Group subnets - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - check_mode: True - - - name: Check result - Update Subnet Group subnets - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is changed - - - name: Update Subnet Group subnets - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - assert: - that: - - update_subnets is successful - - update_subnets is changed - - '"group" in update_subnets' - - '"name" in update_subnets.group' - - '"vpc_id" in update_subnets.group' - - update_subnets.group.name == group_name - - update_subnets.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_subnets' - - '"description" in update_subnets.cluster_subnet_group' - - '"subnet_ids" in update_subnets.cluster_subnet_group' - - '"vpc_id" in update_subnets.cluster_subnet_group' - - update_subnets.cluster_subnet_group.name == group_name - - update_subnets.cluster_subnet_group.description == description_updated - - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids - - update_subnets.cluster_subnet_group.vpc_id == vpc_id - - - name: Update Subnet Group subnets - idempotency - check_mode - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - check_mode: True - - - name: Check result - Update Subnet Group subnets - idempotency - check_mode - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - - name: Update Subnet Group subnets - idempotency - redshift_subnet_group: - state: present - group_name: '{{ group_name }}' - ## No longer mandatory - # group_description: '{{ description_updated }}' - group_subnets: - - '{{ subnet_id_c }}' - - '{{ subnet_id_d }}' - register: update_subnets - - - name: Check result - Update Subnet Group subnets - idempotency - assert: - that: - - update_subnets is successful - - update_subnets is not changed - - '"group" in update_subnets' - - '"name" in update_subnets.group' - - '"vpc_id" in update_subnets.group' - - update_subnets.group.name == group_name - - update_subnets.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_subnets' - - '"description" in update_subnets.cluster_subnet_group' - - '"subnet_ids" in update_subnets.cluster_subnet_group' - - '"vpc_id" in update_subnets.cluster_subnet_group' - - update_subnets.cluster_subnet_group.name == group_name - - update_subnets.cluster_subnet_group.description == description_updated - - subnet_id_a not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_b not in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_c in update_subnets.cluster_subnet_group.subnet_ids - - subnet_id_d in update_subnets.cluster_subnet_group.subnet_ids - - update_subnets.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Delete Subnet Group - check_mode - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - check_mode: True - - - name: Check result - Delete Subnet Group - check_mode - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - - name: Delete Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - check_mode: True - - - name: Check result - Delete Subnet Group - idempotency - check_mode - assert: - that: - - delete_group is not changed - - - name: Delete Subnet Group - idempotency - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - idempotency - assert: - that: - - delete_group is not changed - - # ============================================================ - - - name: Create minimal Subnet Group - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - check_mode: True - - - name: Check result - Create minimal Subnet Group - check_mode - assert: - that: - - create_group is successful - - create_group is changed - - - name: Create minimal Subnet Group - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - assert: - that: - - create_group is successful - - create_group is changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == group_name - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - - name: Create minimal Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - check_mode: True - - - name: Check result - Create minimal Subnet Group - idempotency - check_mode - assert: - that: - - create_group is successful - - create_group is not changed - - - name: Create minimal Subnet Group - idempotency - redshift_subnet_group: - state: present - name: '{{ group_name }}' - subnets: - - '{{ subnet_id_a }}' - register: create_group - - - name: Check result - Create minimal Subnet Group - idempotency - assert: - that: - - create_group is successful - - create_group is not changed - - '"group" in create_group' - - '"name" in create_group.group' - - '"vpc_id" in create_group.group' - - create_group.group.name == group_name - - create_group.group.vpc_id == vpc_id - - '"cluster_subnet_group" in create_group' - - '"description" in create_group.cluster_subnet_group' - - '"subnet_ids" in create_group.cluster_subnet_group' - - '"vpc_id" in create_group.cluster_subnet_group' - - create_group.cluster_subnet_group.name == group_name - - create_group.cluster_subnet_group.description == group_name - - subnet_id_a in create_group.cluster_subnet_group.subnet_ids - - subnet_id_b not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_c not in create_group.cluster_subnet_group.subnet_ids - - subnet_id_d not in create_group.cluster_subnet_group.subnet_ids - - create_group.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Full Update Subnet Group - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - check_mode: True - - - name: Check result - Full Update Subnet Group - check_mode - assert: - that: - - update_complex is successful - - update_complex is changed - - - name: Full Update Subnet Group - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - assert: - that: - - update_complex is successful - - update_complex is changed - - '"group" in update_complex' - - '"name" in update_complex.group' - - '"vpc_id" in update_complex.group' - - update_complex.group.name == group_name - - update_complex.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_complex' - - '"description" in update_complex.cluster_subnet_group' - - '"subnet_ids" in update_complex.cluster_subnet_group' - - '"vpc_id" in update_complex.cluster_subnet_group' - - update_complex.cluster_subnet_group.name == group_name - - update_complex.cluster_subnet_group.description == description_updated - - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids - - update_complex.cluster_subnet_group.vpc_id == vpc_id - - - name: Full Update Subnet Group - idempotency - check_mode - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - check_mode: True - - - name: Check result - Full Update Subnet Group - idempotency - check_mode - assert: - that: - - update_complex is successful - - update_complex is not changed - - - name: Full Update Subnet Group - idempotency - redshift_subnet_group: - state: present - name: '{{ group_name }}' - description: '{{ description_updated }}' - subnets: - - '{{ subnet_id_a }}' - - '{{ subnet_id_b }}' - register: update_complex - - - name: Check result - Full Update Subnet Group - idempotency - assert: - that: - - update_complex is successful - - update_complex is not changed - - '"group" in update_complex' - - '"name" in update_complex.group' - - '"vpc_id" in update_complex.group' - - update_complex.group.name == group_name - - update_complex.group.vpc_id == vpc_id - - '"cluster_subnet_group" in update_complex' - - '"description" in update_complex.cluster_subnet_group' - - '"subnet_ids" in update_complex.cluster_subnet_group' - - '"vpc_id" in update_complex.cluster_subnet_group' - - update_complex.cluster_subnet_group.name == group_name - - update_complex.cluster_subnet_group.description == description_updated - - subnet_id_a in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_b in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_c not in update_complex.cluster_subnet_group.subnet_ids - - subnet_id_d not in update_complex.cluster_subnet_group.subnet_ids - - update_complex.cluster_subnet_group.vpc_id == vpc_id - - # ============================================================ - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - name: '{{ group_name }}' - register: delete_group - - - name: Check result - Delete Subnet Group - assert: - that: - - delete_group is changed - - always: - - ################################################ - # TEARDOWN STARTS HERE - ################################################ - - - name: Delete Subnet Group - redshift_subnet_group: - state: absent - group_name: '{{ group_name }}' - ignore_errors: True - - - name: tidy up subnet - ec2_vpc_subnet: - state: absent - cidr: '{{ item }}' - vpc_id: '{{ vpc_result.vpc.id }}' - loop: - - '{{ subnet_cidr_a }}' - - '{{ subnet_cidr_b }}' - - '{{ subnet_cidr_c }}' - - '{{ subnet_cidr_d }}' - ignore_errors: True - - - name: tidy up VPC - ec2_vpc_net: - state: absent - name: '{{ vpc_name }}' - cidr_block: '{{ vpc_cidr }}' - ignore_errors: True diff --git a/tests/integration/targets/route53/tasks/main.yml b/tests/integration/targets/route53/tasks/main.yml index ae80586dbe8..18f10ae2987 100644 --- a/tests/integration/targets/route53/tasks/main.yml +++ b/tests/integration/targets/route53/tasks/main.yml @@ -503,42 +503,6 @@ - alias_record is not failed - alias_record is not changed - - name: 'Create a weighted record' - route53: - state: present - zone: '{{ zone_one }}' - record: 'weighted.{{ zone_one }}' - type: CNAME - value: 'zid_test.{{ zone_one }}' - overwrite: True - identifier: "host1@www" - weight: 100 - region: '{{ omit }}' - register: weighted_record - - name: 'This should be changed' - assert: - that: - - weighted_record is not failed - - weighted_record is changed - - - name: 'Re-Create a weighted record' - route53: - state: present - zone: '{{ zone_one }}' - record: 'weighted.{{ zone_one }}' - type: CNAME - value: 'zid_test.{{ zone_one }}' - overwrite: True - identifier: "host1@www" - weight: 100 - region: '{{ omit }}' - register: weighted_record - - name: 'This should not be changed' - assert: - that: - - weighted_record is not failed - - weighted_record is not changed - always: - route53_info: query: record_sets @@ -557,20 +521,6 @@ loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' - - name: 'Loop over A/AAAA/CNAME records and delete them' - route53: - state: absent - zone: '{{ zone_one }}' - record: '{{ item.Name }}' - type: '{{ item.Type }}' - value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' - identifier: '{{ item.SetIdentifier }}' - region: '{{ omit }}' - ignore_errors: True - loop: '{{ z1_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' - when: - - '"ResourceRecords" in item' - - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent @@ -601,21 +551,6 @@ loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' when: - '"AliasTarget" in item' - - name: 'Loop over A/AAAA/CNAME records and delete them' - route53: - state: absent - zone: '{{ zone_two }}' - record: '{{ item.Name }}' - type: '{{ item.Type }}' - value: '{{ item.ResourceRecords | map(attribute="Value") | join(",") }}' - identifier: '{{ item.SetIdentifier }}' - region: '{{ omit }}' - private_zone: true - ignore_errors: True - loop: '{{ z2_records.ResourceRecordSets | selectattr("Type", "in", ["A", "AAAA", "CNAME", "CAA"]) | list }}' - when: - - '"ResourceRecords" in item' - - '"SetIdentifier" in item' - name: 'Loop over A/AAAA/CNAME records and delete them' route53: state: absent diff --git a/tests/integration/targets/setup_botocore_pip/defaults/main.yml b/tests/integration/targets/setup_botocore_pip/defaults/main.yml deleted file mode 100644 index 5a50b775907..00000000000 --- a/tests/integration/targets/setup_botocore_pip/defaults/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -default_botocore_version: '1.18.0' -default_boto3_version: '1.15.0' diff --git a/tests/integration/targets/setup_botocore_pip/handlers/main.yml b/tests/integration/targets/setup_botocore_pip/handlers/main.yml deleted file mode 100644 index 2536d1ac773..00000000000 --- a/tests/integration/targets/setup_botocore_pip/handlers/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: 'Delete temporary pip environment' - include_tasks: cleanup.yml diff --git a/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml b/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml deleted file mode 100644 index 25b3ec27efc..00000000000 --- a/tests/integration/targets/setup_botocore_pip/tasks/cleanup.yml +++ /dev/null @@ -1,5 +0,0 @@ -- name: 'Delete temporary pip environment' - file: - path: "{{ botocore_pip_directory }}" - state: absent - no_log: yes diff --git a/tests/integration/targets/setup_botocore_pip/tasks/main.yml b/tests/integration/targets/setup_botocore_pip/tasks/main.yml deleted file mode 100644 index b183b7d726d..00000000000 --- a/tests/integration/targets/setup_botocore_pip/tasks/main.yml +++ /dev/null @@ -1,42 +0,0 @@ -- name: 'Ensure that we have virtualenv available to us' - pip: - name: virtualenv - -- name: 'Create temporary directory for pip environment' - tempfile: - state: directory - prefix: botocore - suffix: .test - register: botocore_pip_directory - notify: - - 'Delete temporary pip environment' - -- name: 'Record temporary directory' - set_fact: - botocore_pip_directory: "{{ botocore_pip_directory.path }}" - -- set_fact: - botocore_virtualenv: "{{ botocore_pip_directory }}/virtualenv" - botocore_virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv" - -- set_fact: - botocore_virtualenv_interpreter: "{{ botocore_virtualenv }}/bin/python" - -- pip: - name: - - 'boto3{{ _boto3_comparison }}{{ _boto3_version }}' - - 'botocore{{ _botocore_comparison }}{{ _botocore_version }}' - - 'coverage<5' - virtualenv: "{{ botocore_virtualenv }}" - virtualenv_command: "{{ botocore_virtualenv_command }}" - virtualenv_site_packages: no - vars: - _boto3_version: '{{ boto3_version | default(default_boto3_version) }}' - _botocore_version: '{{ botocore_version | default(default_botocore_version) }}' - _is_default_boto3: '{{ _boto3_version == default_boto3_version }}' - _is_default_botocore: '{{ _botocore_version == default_botocore_version }}' - # Only set the default to >= if the other dep has been updated and the dep has not been set - _default_boto3_comparison: '{% if _is_default_boto3 and not _is_default_botocore %}>={% else %}=={% endif %}' - _default_botocore_comparison: '{% if _is_default_botocore and not _is_default_boto3 %}>={% else %}=={% endif %}' - _boto3_comparison: '{{ boto3_comparison | default(_default_boto3_comparison) }}' - _botocore_comparison: '{{ botocore_comparison | default(_default_botocore_comparison) }}' diff --git a/tests/integration/targets/setup_ec2_facts/defaults/main.yml b/tests/integration/targets/setup_ec2_facts/defaults/main.yml deleted file mode 100644 index a09e9a53707..00000000000 --- a/tests/integration/targets/setup_ec2_facts/defaults/main.yml +++ /dev/null @@ -1,3 +0,0 @@ -ec2_ami_name: 'Fedora-Cloud-Base-*.x86_64*' -ec2_ami_owner_id: '125523088429' -ec2_ami_ssh_user: 'fedora' diff --git a/tests/integration/targets/setup_ec2_facts/tasks/main.yml b/tests/integration/targets/setup_ec2_facts/tasks/main.yml deleted file mode 100644 index f41791073a3..00000000000 --- a/tests/integration/targets/setup_ec2_facts/tasks/main.yml +++ /dev/null @@ -1,53 +0,0 @@ ---- -# Setup a couple of common facts about the AWS Region -# -# Information about availablity zones -# - ec2_availability_zone_names -# -# An EC2 AMI that can be used for spinning up Instances performs as search -# rather than hardcoding the IDs so we're not limited to specific Regions -# - ec2_ami_id -# -- module_defaults: - group/aws: - aws_access_key: '{{ aws_access_key }}' - aws_secret_key: '{{ aws_secret_key }}' - security_token: '{{ security_token | default(omit) }}' - region: '{{ aws_region }}' - - run_once: True - block: - # ============================================================ - - - name: Get available AZs - aws_az_info: - filters: - region-name: '{{ aws_region }}' - register: _az_info - - - name: Pick an AZ - set_fact: - ec2_availability_zone_names: '{{ _az_info.availability_zones | selectattr("zone_name", "defined") | map(attribute="zone_name") | list }}' - - # ============================================================ - - - name: Get a list of images - ec2_ami_info: - filters: - name: '{{ ec2_ami_name }}' - owner-id: '{{ ec2_ami_owner_id }}' - architecture: x86_64 - virtualization-type: hvm - root-device-type: ebs - register: _images_info - # Very spammy - no_log: True - - - name: Set Fact for latest AMI - vars: - latest_image: '{{ _images_info.images | sort(attribute="creation_date") | reverse | first }}' - set_fact: - ec2_ami_id: '{{ latest_image.image_id }}' - ec2_ami_details: '{{ latest_image }}' - ec2_ami_root_disk: '{{ latest_image.block_device_mappings[0].device_name }}' - ec2_ami_ssh_user: '{{ ec2_ami_ssh_user }}' diff --git a/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py b/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py deleted file mode 100644 index ea2f51b0f4c..00000000000 --- a/tests/integration/targets/setup_sshkey/files/ec2-fingerprint.py +++ /dev/null @@ -1,33 +0,0 @@ -#!/usr/bin/env python -""" -Reads an OpenSSH Public key and spits out the 'AWS' MD5 sum -The equivalent of - -ssh-keygen -f id_rsa.pub -e -m PKCS8 | openssl pkey -pubin -outform DER | openssl md5 -c | cut -f 2 -d ' ' - -(but without needing the OpenSSL CLI) -""" - -from __future__ import absolute_import, division, print_function -__metaclass__ = type - -import hashlib -import sys -from Crypto.PublicKey import RSA - -if len(sys.argv) == 0: - ssh_public_key = "id_rsa.pub" -else: - ssh_public_key = sys.argv[1] - -with open(ssh_public_key, 'r') as key_fh: - data = key_fh.read() - -# Convert from SSH format to DER format -public_key = RSA.importKey(data).exportKey('DER') -md5digest = hashlib.md5(public_key).hexdigest() -# Format the md5sum into the normal format -pairs = zip(md5digest[::2], md5digest[1::2]) -md5string = ":".join(["".join(pair) for pair in pairs]) - -print(md5string) diff --git a/tests/integration/targets/setup_sshkey/tasks/main.yml b/tests/integration/targets/setup_sshkey/tasks/main.yml deleted file mode 100644 index 31bd2176e5c..00000000000 --- a/tests/integration/targets/setup_sshkey/tasks/main.yml +++ /dev/null @@ -1,71 +0,0 @@ -# (c) 2014, James Laska - -# This file is part of Ansible -# -# Ansible is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# Ansible is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with Ansible. If not, see . - -- name: create a temp dir - tempfile: - state: directory - register: sshkey_dir - tags: - - prepare - -- name: ensure script is available - copy: - src: ec2-fingerprint.py - dest: '{{ sshkey_dir.path }}/ec2-fingerprint.py' - mode: 0700 - tags: - - prepare - -- name: Set location of SSH keys - set_fact: - sshkey: '{{ sshkey_dir.path }}/key_one' - another_sshkey: '{{ sshkey_dir.path }}/key_two' - sshkey_pub: '{{ sshkey_dir.path }}/key_one.pub' - another_sshkey_pub: '{{ sshkey_dir.path }}/key_two.pub' - -- name: generate sshkey - shell: echo 'y' | ssh-keygen -P '' -f '{{ sshkey }}' - tags: - - prepare - -- name: record fingerprint - shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ sshkey_pub }}' - register: fingerprint - tags: - - prepare - -- name: generate another_sshkey - shell: echo 'y' | ssh-keygen -P '' -f {{ another_sshkey }} - tags: - - prepare - -- name: record another fingerprint - shell: '{{ sshkey_dir.path }}/ec2-fingerprint.py {{ another_sshkey_pub }}' - register: another_fingerprint - tags: - - prepare - -- name: set facts for future roles - set_fact: - # Public SSH keys (OpenSSH format) - key_material: "{{ lookup('file', sshkey_pub) }}" - another_key_material: "{{ lookup('file', another_sshkey_pub) }}" - # AWS 'fingerprint' (md5digest) - fingerprint: '{{ fingerprint.stdout }}' - another_fingerprint: '{{ another_fingerprint.stdout }}' - tags: - - prepare diff --git a/tests/integration/targets/sns_topic/tasks/main.yml b/tests/integration/targets/sns_topic/tasks/main.yml index 94214b20fa9..891b162e4d2 100644 --- a/tests/integration/targets/sns_topic/tasks/main.yml +++ b/tests/integration/targets/sns_topic/tasks/main.yml @@ -127,7 +127,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "20" + minDelayTarget: 20 maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -153,7 +153,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "20" + minDelayTarget: 20 maxDelayTarget: 20 numRetries: 3 numMaxDelayRetries: 0 @@ -179,7 +179,7 @@ delivery_policy: http: defaultHealthyRetryPolicy: - minDelayTarget: "40" + minDelayTarget: 40 maxDelayTarget: 40 numRetries: 6 numMaxDelayRetries: 0 diff --git a/tests/requirements.yml b/tests/requirements.yml index 3480da42122..27240dbf096 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 1.5.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 1.5.0 diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt deleted file mode 100644 index e5bade76474..00000000000 --- a/tests/sanity/ignore-2.13.txt +++ /dev/null @@ -1,3 +0,0 @@ -plugins/modules/cloudfront_info.py pylint:unnecessary-comprehension # (new test) Should be an easy fix, but testing is a challenge - test are broken and aliases require a wildcard cert in ACM -plugins/modules/iam.py pylint:unnecessary-comprehension # no tests and module is deprecated -plugins/modules/route53.py validate-modules:parameter-state-invalid-choice # route53_info needs improvements before we can deprecate this diff --git a/tests/unit/constraints.txt b/tests/unit/constraints.txt deleted file mode 100644 index bd95eb26733..00000000000 --- a/tests/unit/constraints.txt +++ /dev/null @@ -1,7 +0,0 @@ -# Specifically run tests against the oldest versions that we support -boto3==1.15.0 -botocore==1.18.0 - -# AWS CLI has `botocore==` dependencies, provide the one that matches botocore -# to avoid needing to download over a years worth of awscli wheels. -awscli==1.18.141 diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt index 704c73a25b2..4b10ff777a4 100644 --- a/tests/unit/requirements.txt +++ b/tests/unit/requirements.txt @@ -1,6 +1,3 @@ -# Our code is based on the AWS SDKs -botocore -boto3 -boto - placebo +botocore>=1.16.0 +boto3>=1.13.0