未验证 提交 7df17bcb 编写于 作者: M Mark Chappell 提交者: GitHub

Prepare release 4.0.0 (#1253)

Prepare release 4.0.0

SUMMARY
Prepare release 4.0.0

Changelogs
galaxy.yml
Updated docs

ISSUE TYPE

Docs Pull Request

COMPONENT NAME
CHANGELOG.rst
README.md
changelogs/changelog.yaml
galaxy.yml
docs/
ADDITIONAL INFORMATION
Reviewed-by: NMarkus Bergholz <git@osuv.de>
Reviewed-by: NMandar Kulkarni <mandar242@gmail.com>
Reviewed-by: Alina Buzachis <None>
上级 7f5b872d
此差异已折叠。
此差异已折叠。
此差异已折叠。
bugfixes:
- ecs_taskdefinition - fix broken change detect of ``launch_type`` parameter (https://github.com/ansible-collections/community.aws/pull/1145).
- ecs_service - fix broken compare of ``task_definition`` that results always in a changed task (https://github.com/ansible-collections/community.aws/pull/1145).
- ecs_service - add missing change detect of ``health_check_grace_period_seconds`` parameter (https://github.com/ansible-collections/community.aws/pull/1145).
\ No newline at end of file
minor_changes:
- ecs_service - add ``service`` alias to address the ecs service name with the same parameter as the ecs_service_info module is doing (https://github.com/ansible-collections/community.aws/pull/1187).
- ecs_service_info - add ``name`` alias to address the ecs service name with the same parameter as the ecs_service module is doing (https://github.com/ansible-collections/community.aws/pull/1187).
\ No newline at end of file
minor_changes:
- rds_instance - add support for addition/removal of iam roles to db instance (https://github.com/ansible-collections/community.aws/pull/1002).
bugfixes:
- rds_instance - fix check_mode and idempotency issues and added integration tests for all tests in suite (https://github.com/ansible-collections/community.aws/pull/1002).
minor_changes:
- rds_instance_info - add retries on common AWS failures (https://github.com/ansible-collections/community.aws/pull/1026).
minor_changes:
- ec2_asg - add check mode support (https://github.com/ansible-collections/community.aws/pull/1033).
minor_changes:
- ec2_asg_lifecycle_hook - add integration tests (https://github.com/ansible-collections/community.aws/pull/1048).
- ec2_asg_lifecycle_hook - module now returns info about Life Cycle Hook (https://github.com/ansible-collections/community.aws/pull/1048).
minor_changes:
- aws_kms - fix some bugs in integration tests and add check mode support for key rotation as well as document issues with time taken for requested changes to be reflected on AWS (https://github.com/ansible-collections/community.aws/pull/1052).
- aws_kms - add extra key/value pair to return data (key_policies) to return each policy as a dictionary rather than json string (https://github.com/ansible-collections/community.aws/pull/1052).
minor_changes:
- iam_role - delete inline policies prior to deleting role (https://github.com/ansible-collections/community.aws/pull/1054).
- iam_role - remove global vars and refactor accordingly (https://github.com/ansible-collections/community.aws/pull/1054).
minor_changes:
- iam_user - add `user` value to return data structure to deprecate old `iam_user` (https://github.com/ansible-collections/community.aws/pull/1059).
bugfixes:
- iam_user - don't delete user login profile on check mode (https://github.com/ansible-collections/community.aws/pull/1059).
- iam_user_info - gracefully handle when no users are found (https://github.com/ansible-collections/community.aws/pull/1059).
minor_changes:
- ec2_asg_lifecycle_hook - Added check_mode support (https://github.com/ansible-collections/community.aws/pull/1060).
minor_changes:
- ec2_asg - bugfix to make test setup run once (https://github.com/ansible-collections/community.aws/pull/1061).
bugfixes:
- ec2_asg - Change the default value of ``purge_tags`` to ``false``. Restores previous behaviour (https://github.com/ansible-collections/community.aws/pull/1064).
bugfixes:
- s3_lifecycle - add support of value *0* for ``transition_days`` (https://github.com/ansible-collections/community.aws/pull/1077).
minor_changes:
- rds_instance_snapshot - add copy_db_snapshot functionality (https://github.com/ansible-collections/community.aws/pull/1078).
bugfixes:
- don't require `db_instance_identifier` on state = present (https://github.com/ansible-collections/community.aws/pull/1078).
minor_changes:
- rds_instance - add snapshot tests to test suite to test restoring db from snapshot (https://github.com/ansible-collections/community.aws/pull/1081).
bugfixes:
- rds_instance - fix bugs associated with restoring db instance from snapshot (https://github.com/ansible-collections/community.aws/pull/1081).
bugfixes:
- s3_lifecycle - check that configuration is complete before returning (https://github.com/ansible-collections/community.aws/pull/1085).
minor_changes:
- iam_policy - update broken examples and add RETURN section to documentation; add extra integration tests for idempotency check mode runs (https://github.com/ansible-collections/community.aws/pull/1093).
bugfixes:
- iam_policy - require one of `policy_document` and `policy_json` when state is present to prevent MalformedPolicyDocumentException from being thrown (https://github.com/ansible-collections/community.aws/pull/1093).
minor_changes:
- rds_instance - add `deletion_protection` parameter (https://github.com/ansible-collections/community.aws/pull/1105).
minor_changes:
- lambda - add kms_key_arn parameter (https://github.com/ansible-collections/community.aws/pull/1108).
bugfixes:
- lambda - fix check mode on creation (https://github.com/ansible-collections/community.aws/pull/1108).
- execute_lamba - add waiter for function_updated (https://github.com/ansible-collections/community.aws/pull/1108).
bugfixes:
- elb_application_lb_info - Up default value AWS backoff retries for paginated calls. (https://github.com/ansible-collections/community.aws/pull/1113).
- elb_target_group_info - Up default value AWS backoff retries for paginated calls. (https://github.com/ansible-collections/community.aws/pull/1113).
bugfixes:
- execute_lambda - fix check mode and update RETURN documentation (https://github.com/ansible-collections/community.aws/pull/1115).
minor_changes:
- route53 - add support for GeoLocation param (https://github.com/ansible-collections/amazon.aws/pull/1117).
breaking_changes:
- aws_secret - tags are no longer removed when the ``tags`` parameter is not set. To remove all tags set ``tags={}`` (https://github.com/ansible-collections/community.aws/issues/1146).
minor_changes:
- aws_secret - addition of the ``purge_tags`` parameter (https://github.com/ansible-collections/community.aws/issues/1146).
bugfixes:
- lambda_info - fix bug that forces query=config when getting info for all lambdas. Now, if function name is specified, query will default to all. This may have a performance impact when querying a large number of lambdas.
If function name is not specified, query will default to config (https://github.com/ansible-collections/community.aws/pull/1152).
removed_features:
- ec2_lc - the ``associate_public_ip_address`` option has been removed. It has always been ignored by the module (https://github.com/ansible-collections/community.aws/pull/1158).
removed_features:
- ec2_eip - The ``wait_timeout`` option has been removed. It has always been ignored by the module (https://github.com/ansible-collections/community.aws/pull/1159).
removed_features:
- data_pipeline - the ``version`` option has always been ignored and has been removed (https://github.com/ansible-collections/community.aws/pull/1160"
removed_features:
- ecs_ecr - The deprecated alias ``delete_policy`` has been removed. Please use ``purge_policy`` instead (https://github.com/ansible-collections/community.aws/pull/1161).
removed_features:
- ec2_metric_alarm - support for using the ``<=``, ``<``, ``>`` and ``>=`` operators for comparison has been dropped.
Please use ``LessThanOrEqualToThreshold``, ``LessThanThreshold``, ``GreaterThanThreshold`` or
``GreaterThanOrEqualToThreshold`` instead (https://github.com/ansible-collections/amazon.aws/pull/1164).
removed_features:
- s3_lifecycle - the unused parameter ``requester_pays`` has been removed (https://github.com/ansible-collections/community.aws/pull/1165).
removed_features:
- s3_sync - remove unused ``retries`` parameter (https://github.com/ansible-collections/community.aws/pull/1166).
breaking_changes:
- elb_network_lb - the default value of ``state`` has changed from ``absent`` to ``present`` (https://github.com/ansible-collections/community.aws/pull/1167).
removed_features:
- iam_managed_policy - the unused ``fail_on_delete`` parameter has been removed (https://github.com/ansible-collections/community.aws/pull/1168)
minor_changes:
- ecs_ecr - Will now return repository permission policy if it exists, even if we did not create or modify it. (https://github.com/ansible-collections/community.aws/pull/1171).
\ No newline at end of file
removed_features:
- aws_kms_info - the unused and deprecated ``keys_attr`` parameter has been removed (https://github.com/ansible-collections/amazon.aws/pull/1172).
breaking_changes:
- elb_instance - the ``ec2_elbs`` fact has been removed, ``updated_elbs`` has been added the return values and includes the same information (https://github.com/ansible-collections/community.aws/pull/1173).
minor_changes:
- ecs_service - Now allows for a ``capacity_provider_strategy`` to be utilized when creating/updating a service (https://github.com/ansible-collections/community.aws/pull/1181).
minor_changes:
- aws_glue_job - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- aws_msk_cluster - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- aws_secret - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- aws_step_functions_state_machine - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- ec2_eip - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- ec2_vpc_peer - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- elb_application_lb - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- elb_network_lb - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- iam_role - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- iam_user - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- rds_cluster - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- rds_instance - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- rds_option_group - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- rds_subnet_group - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
- redshift - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
minor_changes:
- efs - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` (https://github.com/ansible-collections/community.aws/pull/1183).
- ec2_transit_gateway - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` (https://github.com/ansible-collections/community.aws/pull/1183).
- eks_fargate_profile - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` (https://github.com/ansible-collections/community.aws/pull/1183).
- elb_target_group - explicitly setting the ``tags`` parameter to the empty dict ``{}`` will now remove all tags unles ``purge_tags`` is explicitly set to ``False`` (https://github.com/ansible-collections/community.aws/pull/1183).
- ec2_transit_gateway - code updated to use common ``ensure_ec2_tags`` helper (https://github.com/ansible-collections/community.aws/pull/1183).
minor_changes:
- ecs_tag - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1184).
- efs_tag - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1184).
minor_changes:
- aws_acm - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- route53_health_check - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- route53_zone - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- sqs_queue - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
deprecated_features:
- aws_acm - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- route53_health_check - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- route53_zone - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- sqs_queue - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
minor_changes:
- aws_kms - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- aws_kms - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1183).
- cloudfront_distribution - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- cloudfront_distribution - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1183).
- ec2_vpc_vpn - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- ec2_vpc_vpn - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1183).
- rds_param_group - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1185).
- rds_param_group - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1183).
deprecated_features:
- aws_kms - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- cloudfront_distribution - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- ec2_vpc_vpn - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
- rds_param_group - the current default value of ``False`` for ``purge_tags`` has been deprecated and will be updated in release 5.0.0 to ``True``.
minor_changes:
- ec2_vpc_nacl - add support for ``purge_tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1189).
- ec2_vpc_nacl - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1189).
- ec2_vpc_nacl - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1189).
minor_changes:
- dynamodb_table - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1199).
minor_changes:
- rds_instance_snapshot - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1200).
minor_changes:
- ec2_snapshot_copy - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1201).
- ec2_snapshot_copy - updated to pass tags as part of the copy API call rather than tagging the snapshot after creation (https://github.com/ansible-collections/community.aws/pull/1201).
bugfixes:
- lambda - fix bug where the lambda module was modifying tags in check mode (https://github.com/ansible-collections/community.aws/pull/1202).
- lambda - fix bug where tag keys were mangled in the return values (https://github.com/ansible-collections/community.aws/pull/1202).
minor_changes:
- lambda - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1202).
- lambda - the behavior for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1202).
minor_changes:
- data_pipeline - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1204).
- ec2_ami_copy - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1204).
- ec2_launch_template - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1204).
- ecs_task - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1204).
minor_changes:
- wafv2_ip_set - Added support for ``purge_tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1205).
- wafv2_ip_set - Added support for updating tags (https://github.com/ansible-collections/community.aws/pull/1205).
- wafv2_ip_set - Added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1205).
- wafv2_ip_set_info - Added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1205).
bugfixes:
- wafv2_rule_group - fix bug where updating just the description did not update the changed state (https://github.com/ansible-collections/community.aws/pull/1210).
- wafv2_rule_group - fix bug where description of resource state was missing when rule groups were updated (https://github.com/ansible-collections/community.aws/pull/1210).
minor_changes:
- wafv2_rule_group - Added support for ``purge_tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1210).
- wafv2_rule_group - Added support for updating tags (https://github.com/ansible-collections/community.aws/pull/1210).
- wafv2_rule_group - Added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1210).
- wafv2_rule_group_info - Added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1210).
bugfixes:
- wafv2_ip_set - fix bug where incorrect changed state was returned when only changing the description (https://github.com/ansible-collections/community.aws/pull/1211).
bugfixes:
- ecs_service - fix broken change detect of ``health_check_grace_period_seconds`` parameter when not specified (https://github.com/ansible-collections/community.aws/pull/1212).
- ecs_service - use default cluster name of ``default`` when not input (https://github.com/ansible-collections/community.aws/pull/1212).
- ecs_task - dont require ``cluster`` and use name of ``default`` when not input (https://github.com/ansible-collections/community.aws/pull/1212).
minor_changes:
- ecs_service - ``deployment_circuit_breaker`` has been added as a supported feature (https://github.com/ansible-collections/community.aws/pull/1215).
\ No newline at end of file
bugfixes:
- wafv2_web_acl - consistently return web ACL info as described in module documentation (https://github.com/ansible-collections/community.aws/pull/1216).
- wafv2_web_acl - fix ``changed`` status when description not specified (https://github.com/ansible-collections/community.aws/pull/1216).
minor_changes:
- wafv2_web_acl - relax botocore requirement to bare minimum required (https://github.com/ansible-collections/community.aws/pull/1216).
minor_changes:
- wafv2_web_acl_info - added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1218).
- wafv2_web_acl - added support for returning tags (https://github.com/ansible-collections/community.aws/pull/1218).
- wafv2_web_acl - Added support for ``purge_tags`` (https://github.com/ansible-collections/community.aws/pull/1218).
- wafv2_web_acl - Added support for updating tags (https://github.com/ansible-collections/community.aws/pull/1218).
- wafv2_web_acl - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1218).
minor_changes:
- cloudtrail - the default value for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` (https://github.com/ansible-collections/community.aws/pull/1219).
- cloudtrail - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1219).
- cloudtrail - updated to pass tags as part of the create API call rather than tagging the trail after creation (https://github.com/ansible-collections/community.aws/pull/1219).
minor_changes:
- aws_codebuild - add support for ``purge_tags`` parameter
(https://github.com/ansible-collections/community.aws/pull/1221).
- aws_codebuild - the ``source`` and ``artifacts`` parameters are now optional unless creating a new project
(https://github.com/ansible-collections/community.aws/pull/1221).
- aws_codebuild - add the ``resource_tags`` parameter which takes the dictionary format for tags instead of the list of dictionaries format
(https://github.com/ansible-collections/community.aws/pull/1221).
- aws_codebuild - add the ``resource_tags`` return value which returns the standard dictionary format for tags instead of the list of
dictionaries format
(https://github.com/ansible-collections/community.aws/pull/1221).
bugfixes:
- aws_codebuild - fix bug where the result may be spuriously flagged as ``changed`` when multiple tags were set on the project
(https://github.com/ansible-collections/community.aws/pull/1221).
deprecated_features:
- aws_codebuild - The ``tags`` parameter currently uses a non-standard format and has been deprecated. In release 6.0.0 this parameter will
accept a simple key/value pair dictionary instead of the current list of dictionaries. It is recommended to migrate to using the
resource_tags parameter which already accepts the simple dictionary format
(https://github.com/ansible-collections/community.aws/pull/1221).
minor_changes:
- ec2_vpc_vgw - add support for ``purge_tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1232).
- ec2_vpc_vgw - the default behaviour for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1232).
- ec2_vpc_vgw - updated to set tags as part of VGW creation instead of tagging the VGW after creation (https://github.com/ansible-collections/community.aws/pull/1232).
- ec2_vpc_vgw_info - added ``resource_tags`` to the return values (https://github.com/ansible-collections/community.aws/pull/1232).
minor_changes:
- cloudwatchlogs_log_group - now consistently returns the values as defined in the return documentation (https://github.com/ansible-collections/community.aws/pull/1233).
- cloudwatchlogs_log_group - adds support for updating tags (https://github.com/ansible-collections/community.aws/pull/1233).
- cloudwatchlogs_log_group - adds support for returning tags (https://github.com/ansible-collections/community.aws/pull/1233).
- cloudwatchlogs_log_group_info - adds support for returning tags (https://github.com/ansible-collections/community.aws/pull/1233).
minor_changes:
- dms_endpoint - ``endpointtype`` and ``enginename`` no longer required when deleting an endpoint (https://github.com/ansible-collections/community.aws/pull/1234).
- dms_endpoint - ``resource_tags`` added as an alias for ``tags`` (https://github.com/ansible-collections/community.aws/pull/1234).
- dms_endpoint - added support for ``purge_tags`` (https://github.com/ansible-collections/community.aws/pull/1234).
- dms_endpoint - now returns details of the endpoint (https://github.com/ansible-collections/community.aws/pull/1234).
deprecated_features:
- route53_info - The CamelCase return values for ```HostedZones```, ```ResourceRecordSets```, and ```HealthChecks```
have been deprecated, in the future release you must use snake_case return values ```hosted_zones```, ```resource_record_sets```,
and ```health_checks``` instead respectively".
\ No newline at end of file
minor_changes:
- route53_info - add RETURN section to documentation (https://github.com/ansible-collections/community.aws/pull/1240).
bugfixes:
- aws_ssm_parameter_store - fix exception when description was set without value (https://github.com/ansible-collections/community.aws/pull/1241).
minor_changes:
- aws_ssm_parameter_store - add parameter_metadata to the returned values (https://github.com/ansible-collections/community.aws/pull/1241).
bugfixes:
- ec2_vpc_vpn - fix exception when no tags are passed in check mode (https://github.com/ansible-collections/community.aws/pull/1242).
bugfixes:
- ecs_service - fix validation for ``placement_constraints``. It's possible to use ``distinctInstance`` placement constraint now (https://github.com/ansible-collections/community.aws/issues/1058)
breaking_changes:
- community.aws collection - the ``profile`` parameter is now mutually exclusive with the ``aws_access_key``,
``aws_secret_key`` and ``security_token`` parameters (https://github.com/ansible-collections/amazon.aws/pull/834).
minor_changes:
- rds_instance_snapshot - update module to use handlers defined in module_utils/rds.py (https://github.com/ansible-collections/community.aws/pull/789).
- rds_instance_snapshot - add ``check_mode`` (https://github.com/ansible-collections/community.aws/pull/789).
- rds_instance_snapshot - add integration tests (https://github.com/ansible-collections/community.aws/pull/789).
breaking_changes:
- Tags beginning with ``aws:`` will not be removed when purging tags, these tags are reserved by Amazon and may not be updated or deleted (https://github.com/ansible-collections/amazon.aws/issues/817).
breaking_changes:
- script_inventory_ec2 - The ec2.py inventory script has been 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 has been removed from this collection.
We recommend migrating from the script to the amazon.aws.ec2 inventory plugin. (https://github.com/ansible-collections/community.aws/pull/898)
- community.aws collection - The ``community.aws`` collection has now dropped support for and any requirements upon the original ``boto`` AWS SDK, and now uses the ``boto3``/``botocore`` AWS SDK
(https://github.com/ansible-collections/community.aws/pull/898).
bugfixes:
- dynamodb_table - fix an issue when creating secondary indexes with global_keys_only (https://github.com/ansible-collections/community.aws/issues/967).
---
minor_changes:
- ec2_transit_gateway - wait and retry if API returns an IncorrectState error.
major_changes:
- community.aws collection - The amazon.aws collection has dropped support for
``botocore<1.20.0`` and ``boto3<1.17.0``. 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/community.aws/pull/956).
breaking_changes:
- ec2_vpc_route_table - 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_route_table``.
- ec2_vpc_route_table_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_route_table_info``.
\ No newline at end of file
bugfixes:
- "aws_ssm connection plugin - fix linting errors in documentation data (https://github.com/ansible-collections/community.aws/pull/965)."
......@@ -27,8 +27,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -55,8 +55,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -73,7 +72,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -91,7 +89,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -107,8 +104,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -193,8 +189,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -227,9 +222,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -301,7 +296,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -18,10 +18,11 @@ Version added: 1.0.0
Synopsis
--------
- Import and delete certificates in Amazon Web Service's Certificate Manager (AWS ACM).
- This module does not currently interact with AWS-provided certificates. It currently only manages certificates provided to AWS by the user.
- The ACM API allows users to upload multiple certificates for the same domain name, and even multiple identical certificates. This module attempts to restrict such freedoms, to be idempotent, as per the Ansible philosophy. It does this through applying AWS resource "Name" tags to ACM certificates.
- When *state=present*, if there is one certificate in ACM with a ``Name`` tag equal to the ``name_tag`` parameter, and an identical body and chain, this task will succeed without effect.
- When *state=present*, if there is one certificate in ACM with a ``Name`` tag equal to the *name_tag* parameter, and an identical body and chain, this task will succeed without effect.
- When *state=present*, if there is one certificate in ACM a *Name* tag equal to the *name_tag* parameter, and a different body, this task will overwrite that certificate.
......@@ -37,13 +38,14 @@ Synopsis
Requirements
------------
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -70,8 +72,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -88,7 +89,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -106,7 +106,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -122,8 +121,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -140,7 +138,7 @@ Parameters
</td>
<td>
<div>The body of the PEM encoded public certificate.</div>
<div>Required when <em>state</em> is not <code>absent</code>.</div>
<div>Required when <em>state</em> is not <code>absent</code> and the certificate does not exist.</div>
<div>If your certificate is in a file, use <code>lookup(&#x27;file&#x27;, &#x27;path/to/cert.pem&#x27;</code>).</div>
</td>
</tr>
......@@ -156,8 +154,8 @@ Parameters
<td>
</td>
<td>
<div>The ARN of a certificate in ACM to delete</div>
<div>Ignored when <em>state=present</em>.</div>
<div>The ARN of a certificate in ACM to modify or delete.</div>
<div>If <em>state=present</em>, the certificate with the specified ARN can be updated. For example, this can be used to add/remove tags to an existing certificate.</div>
<div>If <em>state=absent</em>, you must provide one of <em>certificate_arn</em>, <em>domain_name</em> or <em>name_tag</em>.</div>
<div>If <em>state=absent</em> and no resource exists with this ARN in this region, the task will succeed with no effect.</div>
<div>If <em>state=absent</em> and the corresponding resource exists in a different region, this task may report success without deleting that resource.</div>
......@@ -214,7 +212,7 @@ Parameters
<td>
<div>The domain name of the certificate.</div>
<div>If <em>state=absent</em> and <em>domain_name</em> is specified, this task will delete all ACM certificates with this domain.</div>
<div>Exactly one of <em>domain_name</em>, <em>name_tag</em> and <em>certificate_arn</em> must be provided.</div>
<div>Exactly one of <em>domain_name</em>, <em>name_tag</em> and <em>certificate_arn</em> must be provided.</div>
<div>If <em>state=present</em> this must not be specified. (Since the domain name is encoded within the public certificate&#x27;s body.)</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: domain</div>
</td>
......@@ -251,7 +249,10 @@ Parameters
<div>This can be any set of characters accepted by AWS for tag values.</div>
<div>This is to ensure Ansible can treat certificates idempotently, even though the ACM API allows duplicate certificates.</div>
<div>If <em>state=preset</em>, this must be specified.</div>
<div>If <em>state=absent</em> and <em>name_tag</em> is specified, this task will delete all ACM certificates with this Name tag.</div>
<div>If <em>state=absent</em>, you must provide exactly one of <em>certificate_arn</em>, <em>domain_name</em> or <em>name_tag</em>.</div>
<div>If both <em>name_tag</em> and the &#x27;Name&#x27; tag in <em>tags</em> are set, the values must be the same.</div>
<div>If the &#x27;Name&#x27; tag in <em>tags</em> is not set and <em>name_tag</em> is set, the <em>name_tag</em> value is copied to <em>tags</em>.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
</td>
</tr>
......@@ -268,7 +269,7 @@ Parameters
</td>
<td>
<div>The body of the PEM encoded private key.</div>
<div>Required when <em>state=present</em>.</div>
<div>Required when <em>state=present</em> and the certificate does not exist.</div>
<div>Ignored when <em>state=absent</em>.</div>
<div>If your private key is in a file, use <code>lookup(&#x27;file&#x27;, &#x27;path/to/key.pem&#x27;</code>).</div>
</td>
......@@ -285,11 +286,32 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>purge_tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>If <em>purge_tags=true</em> and <em>tags</em> is set, existing tags will be purged from the resource to match exactly what is defined by <em>tags</em> parameter.</div>
<div>If the <em>tags</em> parameter is not set then tags will not be modified, even if <em>purge_tags=True</em>.</div>
<div>Tag keys beginning with <code>aws:</code> are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the <em>purge_tags</em> parameter. See the Amazon documentation for more information <a href='https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions'>https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions</a>.</div>
<div>The current default value of <code>False</code> has been deprecated. The default value will change to <code>True</code> in release 5.0.0.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
......@@ -319,9 +341,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -344,6 +366,23 @@ Parameters
<div>If <em>state=absent</em>, any certificates in this region with a corresponding <em>domain_name</em>, <em>name_tag</em> or <em>certificate_arn</em> will be deleted.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>A dictionary representing the tags to be applied to the resource.</div>
<div>If the <em>tags</em> parameter is not set then tags will not be modified.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: resource_tags</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
......@@ -371,9 +410,9 @@ Notes
-----
.. note::
- Support for *tags* and *purge_tags* was added in release 3.2.0
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......@@ -393,7 +432,7 @@ Examples
- name: create/update a certificate with a chain
community.aws.aws_acm:
certificate: "{{ lookup('file', 'cert.pem' ) }}"
privateKey: "{{ lookup('file', 'key.pem' ) }}"
private_key: "{{ lookup('file', 'key.pem' ) }}"
name_tag: my_cert
certificate_chain: "{{ lookup('file', 'chain.pem' ) }}"
state: present
......@@ -422,6 +461,15 @@ Examples
state: absent
region: ap-southeast-2
- name: add tags to an existing certificate with a particular ARN
community.aws.aws_acm:
certificate_arn: "arn:aws:acm:ap-southeast-2:123456789012:certificate/01234567-abcd-abcd-abcd-012345678901"
tags:
Name: my_certificate
Application: search
Environment: development
purge_tags: true
Return Values
......
此差异已折叠。
......@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -71,8 +71,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -89,7 +88,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -107,7 +105,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -123,8 +120,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -258,8 +254,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -292,9 +287,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -463,7 +458,6 @@ Notes
- 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.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -244,8 +240,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -320,9 +315,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -531,7 +526,6 @@ Notes
- 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.
......
......@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -56,8 +56,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -74,7 +73,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -92,7 +90,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -108,8 +105,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -343,8 +339,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -394,9 +389,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -530,7 +525,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -71,8 +71,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -89,7 +88,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -107,7 +105,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -123,8 +120,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -241,7 +237,7 @@ Parameters
<td>
</td>
<td>
<div>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image &lt;colon&gt;tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.</div>
<div>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code>repository-url/image-name:tag</code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.</div>
</td>
</tr>
<tr>
......@@ -413,8 +409,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -462,9 +457,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -676,7 +671,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -56,8 +56,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -74,7 +73,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -92,7 +90,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -108,8 +105,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -261,8 +257,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -295,9 +290,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -348,7 +343,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -48,13 +48,13 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
</td>
<td>
<div>Information about the build output artifacts for the build project.</div>
<div><em>artifacts</em> is required when creating a new project.</div>
</td>
</tr>
<tr>
......@@ -171,8 +171,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -189,7 +188,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -207,7 +205,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -223,8 +220,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -472,11 +468,31 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>purge_tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul>
</td>
<td>
<div>If <em>purge_tags=true</em> and <em>tags</em> is set, existing tags will be purged from the resource to match exactly what is defined by <em>tags</em> parameter.</div>
<div>If the <em>resource_tags</em> parameter is not set then tags will not be modified, even if <em>purge_tags=True</em>.</div>
<div>Tag keys beginning with <code>aws:</code> are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the <em>purge_tags</em> parameter. See the Amazon documentation for more information <a href='https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions'>https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions</a>.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
......@@ -493,6 +509,23 @@ Parameters
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>resource_tags</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>A dictionary representing the tags to be applied to the build project.</div>
<div>If the <em>resource_tags</em> parameter is not set then tags will not be modified.</div>
<div>Mutually exclusive with the <em>tags</em> parameter.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
......@@ -506,9 +539,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -533,13 +566,13 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
</td>
<td>
<div>Configure service and location for the build input source.</div>
<div><em>source</em> is required when creating a new project.</div>
</td>
</tr>
<tr>
......@@ -661,6 +694,8 @@ Parameters
</td>
<td>
<div>A set of tags for the build project.</div>
<div>Mutually exclusive with the <em>resource_tags</em> parameter.</div>
<div>In release 6.0.0 this parameter will accept a simple dictionary instead of the list of dictionaries format. To use the simple dictionary format prior to release 6.0.0 the <em>resource_tags</em> can be used instead of <em>tags</em>.</div>
</td>
</tr>
<tr>
......@@ -757,7 +792,6 @@ Notes
- 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.
......@@ -979,6 +1013,24 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">my_project</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>reource_tags</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 4.0.0</div>
</td>
<td>when configured</td>
<td>
<div>A simple dictionary representing the tags added to the project.</div>
<div><em>tags</em> and <em>reource_tags</em> represent the same information in different formats.</div>
<br/>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="2">
......@@ -1130,7 +1182,8 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
</td>
<td>when configured</td>
<td>
<div>Tags added to the project</div>
<div>Tags added to the project in the boto3 list of dictionaries format.</div>
<div><em>tags</em> and <em>reource_tags</em> represent the same information in different formats.</div>
<br/>
</td>
</tr>
......
......@@ -27,8 +27,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -55,8 +55,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -73,7 +72,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -91,7 +89,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -107,8 +104,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -191,8 +187,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -225,9 +220,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -279,7 +274,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -103,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -121,7 +120,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -139,7 +137,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -155,8 +152,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -223,8 +219,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -273,9 +268,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -395,7 +390,6 @@ Notes
- 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.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -86,8 +86,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -104,7 +103,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -122,7 +120,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -138,8 +135,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -190,8 +186,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -224,9 +219,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -277,7 +272,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -126,8 +126,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -144,7 +143,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -162,7 +160,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -178,8 +175,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -316,8 +312,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -350,9 +345,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -403,7 +398,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -196,8 +192,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -261,9 +256,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -329,7 +324,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -174,8 +170,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -295,9 +290,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -348,7 +343,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -226,8 +222,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -340,9 +335,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -376,9 +371,9 @@ Parameters
<td>
<div>Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.</div>
<div>This parameter expects a list of dictionaries. Each dictionary expects the following key/value pairs.</div>
<div>Key `EventSource` The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.</div>
<div>Key `MessageType` The type of notification that triggers AWS Config to run an evaluation for a rule.</div>
<div>Key `MaximumExecutionFrequency` The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.</div>
<div>Key <code>EventSource</code> The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.</div>
<div>Key <code>MessageType</code> The type of notification that triggers AWS Config to run an evaluation for a rule.</div>
<div>Key <code>MaximumExecutionFrequency</code> The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.</div>
</td>
</tr>
<tr>
......@@ -462,7 +457,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -27,8 +27,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -55,8 +55,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -73,7 +72,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -91,7 +89,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -107,8 +104,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -191,8 +187,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -225,9 +220,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -259,7 +254,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -263,8 +259,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -297,9 +292,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -351,7 +346,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -29,8 +29,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -73,8 +73,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -91,7 +90,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -109,7 +107,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -125,8 +122,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -208,8 +204,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -242,9 +237,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -327,7 +322,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -301,8 +297,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -335,9 +330,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -426,7 +421,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -99,8 +99,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -117,7 +116,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -135,7 +133,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -151,8 +148,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -298,8 +294,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -351,9 +346,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -452,7 +447,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -54,8 +54,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -72,7 +71,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -90,7 +88,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -106,8 +103,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -174,8 +170,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -239,9 +234,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -358,7 +353,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
......@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
- boto3 >= 1.16.0
- botocore >= 1.19.0
- boto3 >= 1.17.0
- botocore >= 1.20.0
Parameters
......@@ -70,8 +70,7 @@ Parameters
</td>
<td>
<div><code>AWS access key</code>. If not set then the value of the <code>AWS_ACCESS_KEY_ID</code>, <code>AWS_ACCESS_KEY</code> or <code>EC2_ACCESS_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_access_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_access_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
</tr>
......@@ -88,7 +87,6 @@ Parameters
</td>
<td>
<div>The location of a CA Bundle to use when validating SSL certificates.</div>
<div>Not used by boto 2 based modules.</div>
<div>Note: The CA Bundle is read &#x27;module&#x27; side and may need to be explicitly copied from the controller if not run locally.</div>
</td>
</tr>
......@@ -106,7 +104,6 @@ Parameters
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
</td>
</tr>
<tr>
......@@ -122,8 +119,7 @@ Parameters
</td>
<td>
<div><code>AWS secret key</code>. If not set then the value of the <code>AWS_SECRET_ACCESS_KEY</code>, <code>AWS_SECRET_KEY</code>, or <code>EC2_SECRET_KEY</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>aws_secret_key</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div>The <em>aws_secret_key</em> and <em>profile</em> options are mutually exclusive.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
</tr>
......@@ -189,8 +185,7 @@ Parameters
<td>
</td>
<td>
<div>Using <em>profile</em> will override <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> and support for passing them at the same time as <em>profile</em> has been deprecated.</div>
<div><em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> will be made mutually exclusive with <em>profile</em> after 2022-06-01.</div>
<div>The <em>profile</em> option is mutually exclusive with the <em>aws_access_key</em>, <em>aws_secret_key</em> and <em>security_token</em> options.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_profile</div>
</td>
</tr>
......@@ -223,9 +218,9 @@ Parameters
</td>
<td>
<div><code>AWS STS security token</code>. If not set then the value of the <code>AWS_SECURITY_TOKEN</code> or <code>EC2_SECURITY_TOKEN</code> environment variable is used.</div>
<div>If <em>profile</em> is set this parameter is ignored.</div>
<div>Passing the <em>security_token</em> and <em>profile</em> options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_security_token, access_token</div>
<div>The <em>security_token</em> and <em>profile</em> options are mutually exclusive.</div>
<div>Aliases <em>aws_session_token</em> and <em>session_token</em> have been added in version 3.2.0.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_session_token, session_token, aws_security_token, access_token</div>
</td>
</tr>
<tr>
......@@ -295,7 +290,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
......
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册