From 85c61785f0f51c93ef7792c4ef2a7cc9bea2808b Mon Sep 17 00:00:00 2001 From: Jill R <4121322+jillr@users.noreply.github.com> Date: Tue, 27 Apr 2021 06:40:45 -0700 Subject: [PATCH] Prepare 1.5.0 release (#342) Prepare 1.5.0 release Reviewed-by: https://github.com/apps/ansible-zuul --- CHANGELOG.rst | 35 +++ README.md | 2 +- changelogs/changelog.yaml | 59 +++++ ...pport-for-StackPolicyDuringUpdateBody.yaml | 2 - .../241_ec2_vol-add_purge_tags_parameter.yaml | 3 - ...vol-preset-the-name-tag-of-the-volume.yaml | 3 - .../261-scrub-params-descend-into-lists.yml | 3 - changelogs/fragments/270-vpc-waiters.yaml | 3 - .../fragments/271-normalize_boto3_result.yml | 2 - changelogs/fragments/288-has_boto3.yml | 3 - changelogs/fragments/291-lint-cleanup.yml | 3 - .../295-aws_account_attribute-awsretry.yml | 2 - .../fragments/305-ec2_vol-no-platform.yml | 2 - changelogs/fragments/309-ec2_tags.yml | 6 - ...max_results_and_next_token_parameters.yaml | 3 - ...2_inventory_includes_entries_matching.yaml | 3 - ...ontrib_script_compatible_ec2_tag_keys.yaml | 3 - .../43-ec2_metadata_facts-IMDSv2.yml | 2 - .../57-aws_ec2-support-for-templates.yml | 2 - changelogs/fragments/ignore_212.yml | 2 - docs/amazon.aws.aws_ec2_inventory.rst | 246 ++++++++++++++++-- docs/amazon.aws.aws_rds_inventory.rst | 162 ++++++++++-- docs/amazon.aws.cloudformation_module.rst | 34 ++- docs/amazon.aws.ec2_elb_lb_module.rst | 2 +- docs/amazon.aws.ec2_group_module.rst | 2 +- docs/amazon.aws.ec2_metadata_facts_module.rst | 8 +- docs/amazon.aws.ec2_snapshot_info_module.rst | 91 ++++++- docs/amazon.aws.ec2_vol_module.rst | 21 +- galaxy.yml | 2 +- 29 files changed, 608 insertions(+), 103 deletions(-) delete mode 100644 changelogs/fragments/155-support-for-StackPolicyDuringUpdateBody.yaml delete mode 100644 changelogs/fragments/241_ec2_vol-add_purge_tags_parameter.yaml delete mode 100644 changelogs/fragments/242_ec2_vol-preset-the-name-tag-of-the-volume.yaml delete mode 100644 changelogs/fragments/261-scrub-params-descend-into-lists.yml delete mode 100644 changelogs/fragments/270-vpc-waiters.yaml delete mode 100644 changelogs/fragments/271-normalize_boto3_result.yml delete mode 100644 changelogs/fragments/288-has_boto3.yml delete mode 100644 changelogs/fragments/291-lint-cleanup.yml delete mode 100644 changelogs/fragments/295-aws_account_attribute-awsretry.yml delete mode 100644 changelogs/fragments/305-ec2_vol-no-platform.yml delete mode 100644 changelogs/fragments/309-ec2_tags.yml delete mode 100644 changelogs/fragments/321-ec2_snapshot_info-add_max_results_and_next_token_parameters.yaml delete mode 100644 changelogs/fragments/328_aws_ec2_inventory_includes_entries_matching.yaml delete mode 100644 changelogs/fragments/331_aws_ec2_inventory_use_contrib_script_compatible_ec2_tag_keys.yaml delete mode 100644 changelogs/fragments/43-ec2_metadata_facts-IMDSv2.yml delete mode 100644 changelogs/fragments/57-aws_ec2-support-for-templates.yml delete mode 100644 changelogs/fragments/ignore_212.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2428b5aaa47..e15b50713db 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,41 @@ community.aws Release Notes .. contents:: Topics +v1.5.0 +====== + +Minor Changes +------------- + +- AWS inventory plugins - use shared HAS_BOTO3 helper rather than copying code (https://github.com/ansible-collections/amazon.aws/pull/288). +- AWS lookup plugins - use shared HAS_BOTO3 helper rather than copying code (https://github.com/ansible-collections/amazon.aws/pull/288). +- aws_account_attribute - add retries on common AWS failures (https://github.com/ansible-collections/amazon.aws/pull/295). +- aws_ec2 inventory - expose a new configuration key ``use_contrib_script_compatible_ec2_tag_keys`` to reproduce a behavior of the old ``ec2.py`` inventory script. With this option enabled, each tag is exposed using a ``ec2_tag_TAGNAME`` key (https://github.com/ansible-collections/amazon.aws/pull/331). +- aws_ec2 inventory - expose to new keys called ``include_filters`` and ``exclude_filters`` to give the user the ability to compose an inventory with multiple queries (https://github.com/ansible-collections/amazon.aws/pull/328). +- aws_ec2 inventory plugin - Added support for using Jinja2 templates in the authentication fields (https://github.com/ansible-collections/amazon.aws/pull/57). +- cloudformation - added support for StackPolicyDuringUpdateBody (https://github.com/ansible-collections/amazon.aws/pull/155). +- ec2_metadata_facts - add support for IMDSv2 (https://github.com/ansible-collections/amazon.aws/pull/43). +- ec2_snapshot_info - add the ``max_results`` along with ``next_token_id`` option (https://github.com/ansible-collections/amazon.aws/pull/321). +- ec2_tag - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). +- ec2_tag_info - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). +- ec2_vol - add the ``purge_tags`` option (https://github.com/ansible-collections/amazon.aws/pull/242). +- ec2_vol - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). +- ec2_vpc_net - use a custom waiter which can handle API rate limiting (https://github.com/ansible-collections/amazon.aws/pull/270). +- ec2_vpc_subnet - use AWSRetry decorator to more consistently handle API rate limiting (https://github.com/ansible-collections/amazon.aws/pull/270). +- ec2_vpc_subnet - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). +- module_utils.cloudfront_facts - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). +- module_utils.ec2 - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). +- module_utils/core - add a helper function ``normalize_boto3_result`` (https://github.com/ansible-collections/amazon.aws/pull/271). +- module_utils/core - add parameter ``descend_into_lists`` to ``scrub_none_parameters`` helper function (https://github.com/ansible-collections/amazon.aws/pull/262). +- module_utils/ec2 - added additional helper functions for tagging EC2 resources (https://github.com/ansible-collections/amazon.aws/pull/309). +- sanity tests - add ignore.txt for 2.12 (https://github.com/ansible-collections/amazon.aws/pull/315). + +Bugfixes +-------- + +- ec2_vol - create or update now preserves the existing tags, including Name (https://github.com/ansible-collections/amazon.aws/issues/229) +- ec2_vol - fix exception when platform information isn't available (https://github.com/ansible-collections/amazon.aws/issues/305). + v1.4.0 ====== diff --git a/README.md b/README.md index fb57e278194..e722d92a7c3 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Name | Description [amazon.aws.ec2_group](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_group_module.rst)|maintain an ec2 VPC security group. [amazon.aws.ec2_group_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_group_info_module.rst)|Gather information about ec2 security groups in AWS. [amazon.aws.ec2_key](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_key_module.rst)|create or delete an ec2 key pair -[amazon.aws.ec2_metadata_facts](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_metadata_facts_module.rst)|Gathers facts (instance metadata) about remote hosts within ec2 +[amazon.aws.ec2_metadata_facts](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_metadata_facts_module.rst)|gathers facts (instance metadata) about remote hosts within EC2 [amazon.aws.ec2_snapshot](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_snapshot_module.rst)|Creates a snapshot from an existing volume [amazon.aws.ec2_snapshot_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_snapshot_info_module.rst)|Gather information about ec2 volume snapshots in AWS [amazon.aws.ec2_tag](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_tag_module.rst)|create and remove tags on ec2 resources diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index d339dc57e1b..ebf28b97ecf 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -233,3 +233,62 @@ releases: - 25-aws_ec2-hostname-options-concatenation.yaml - 273-vendor-ipaddress-utility.yml release_date: '2021-03-05' + 1.5.0: + changes: + bugfixes: + - ec2_vol - create or update now preserves the existing tags, including Name + (https://github.com/ansible-collections/amazon.aws/issues/229) + - ec2_vol - fix exception when platform information isn't available (https://github.com/ansible-collections/amazon.aws/issues/305). + minor_changes: + - AWS inventory plugins - use shared HAS_BOTO3 helper rather than copying code + (https://github.com/ansible-collections/amazon.aws/pull/288). + - AWS lookup plugins - use shared HAS_BOTO3 helper rather than copying code + (https://github.com/ansible-collections/amazon.aws/pull/288). + - aws_account_attribute - add retries on common AWS failures (https://github.com/ansible-collections/amazon.aws/pull/295). + - aws_ec2 inventory - expose a new configuration key ``use_contrib_script_compatible_ec2_tag_keys`` + to reproduce a behavior of the old ``ec2.py`` inventory script. With this + option enabled, each tag is exposed using a ``ec2_tag_TAGNAME`` key (https://github.com/ansible-collections/amazon.aws/pull/331). + - aws_ec2 inventory - expose to new keys called ``include_filters`` and ``exclude_filters`` + to give the user the ability to compose an inventory with multiple queries + (https://github.com/ansible-collections/amazon.aws/pull/328). + - aws_ec2 inventory plugin - Added support for using Jinja2 templates in the + authentication fields (https://github.com/ansible-collections/amazon.aws/pull/57). + - cloudformation - added support for StackPolicyDuringUpdateBody (https://github.com/ansible-collections/amazon.aws/pull/155). + - ec2_metadata_facts - add support for IMDSv2 (https://github.com/ansible-collections/amazon.aws/pull/43). + - ec2_snapshot_info - add the ``max_results`` along with ``next_token_id`` option + (https://github.com/ansible-collections/amazon.aws/pull/321). + - ec2_tag - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). + - ec2_tag_info - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). + - ec2_vol - add the ``purge_tags`` option (https://github.com/ansible-collections/amazon.aws/pull/242). + - ec2_vol - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). + - ec2_vpc_net - use a custom waiter which can handle API rate limiting (https://github.com/ansible-collections/amazon.aws/pull/270). + - ec2_vpc_subnet - use AWSRetry decorator to more consistently handle API rate + limiting (https://github.com/ansible-collections/amazon.aws/pull/270). + - ec2_vpc_subnet - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). + - module_utils.cloudfront_facts - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). + - module_utils.ec2 - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). + - module_utils/core - add a helper function ``normalize_boto3_result`` (https://github.com/ansible-collections/amazon.aws/pull/271). + - module_utils/core - add parameter ``descend_into_lists`` to ``scrub_none_parameters`` + helper function (https://github.com/ansible-collections/amazon.aws/pull/262). + - module_utils/ec2 - added additional helper functions for tagging EC2 resources + (https://github.com/ansible-collections/amazon.aws/pull/309). + - sanity tests - add ignore.txt for 2.12 (https://github.com/ansible-collections/amazon.aws/pull/315). + fragments: + - 155-support-for-StackPolicyDuringUpdateBody.yaml + - 241_ec2_vol-add_purge_tags_parameter.yaml + - 242_ec2_vol-preset-the-name-tag-of-the-volume.yaml + - 261-scrub-params-descend-into-lists.yml + - 270-vpc-waiters.yaml + - 271-normalize_boto3_result.yml + - 288-has_boto3.yml + - 291-lint-cleanup.yml + - 295-aws_account_attribute-awsretry.yml + - 305-ec2_vol-no-platform.yml + - 309-ec2_tags.yml + - 321-ec2_snapshot_info-add_max_results_and_next_token_parameters.yaml + - 328_aws_ec2_inventory_includes_entries_matching.yaml + - 331_aws_ec2_inventory_use_contrib_script_compatible_ec2_tag_keys.yaml + - 43-ec2_metadata_facts-IMDSv2.yml + - 57-aws_ec2-support-for-templates.yml + - ignore_212.yml + release_date: '2021-04-27' diff --git a/changelogs/fragments/155-support-for-StackPolicyDuringUpdateBody.yaml b/changelogs/fragments/155-support-for-StackPolicyDuringUpdateBody.yaml deleted file mode 100644 index 97f29a184cd..00000000000 --- a/changelogs/fragments/155-support-for-StackPolicyDuringUpdateBody.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - cloudformation - added support for StackPolicyDuringUpdateBody (https://github.com/ansible-collections/amazon.aws/pull/155). diff --git a/changelogs/fragments/241_ec2_vol-add_purge_tags_parameter.yaml b/changelogs/fragments/241_ec2_vol-add_purge_tags_parameter.yaml deleted file mode 100644 index 56cdcfa9458..00000000000 --- a/changelogs/fragments/241_ec2_vol-add_purge_tags_parameter.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: -- ec2_vol - add the ``purge_tags`` option (https://github.com/ansible-collections/amazon.aws/pull/242). diff --git a/changelogs/fragments/242_ec2_vol-preset-the-name-tag-of-the-volume.yaml b/changelogs/fragments/242_ec2_vol-preset-the-name-tag-of-the-volume.yaml deleted file mode 100644 index efb2a72e676..00000000000 --- a/changelogs/fragments/242_ec2_vol-preset-the-name-tag-of-the-volume.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: -- ec2_vol - create or update now preserves the existing tags, including Name (https://github.com/ansible-collections/amazon.aws/issues/229) diff --git a/changelogs/fragments/261-scrub-params-descend-into-lists.yml b/changelogs/fragments/261-scrub-params-descend-into-lists.yml deleted file mode 100644 index 1116d35ed27..00000000000 --- a/changelogs/fragments/261-scrub-params-descend-into-lists.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - module_utils/core - add parameter ``descend_into_lists`` to ``scrub_none_parameters`` helper function (https://github.com/ansible-collections/amazon.aws/pull/262). diff --git a/changelogs/fragments/270-vpc-waiters.yaml b/changelogs/fragments/270-vpc-waiters.yaml deleted file mode 100644 index d97a0ffc72b..00000000000 --- a/changelogs/fragments/270-vpc-waiters.yaml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- ec2_vpc_net - use a custom waiter which can handle API rate limiting (https://github.com/ansible-collections/amazon.aws/pull/270). -- ec2_vpc_subnet - use AWSRetry decorator to more consistently handle API rate limiting (https://github.com/ansible-collections/amazon.aws/pull/270). diff --git a/changelogs/fragments/271-normalize_boto3_result.yml b/changelogs/fragments/271-normalize_boto3_result.yml deleted file mode 100644 index 5354b342541..00000000000 --- a/changelogs/fragments/271-normalize_boto3_result.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- module_utils/core - add a helper function ``normalize_boto3_result`` (https://github.com/ansible-collections/amazon.aws/pull/271). diff --git a/changelogs/fragments/288-has_boto3.yml b/changelogs/fragments/288-has_boto3.yml deleted file mode 100644 index ef3f37e22b9..00000000000 --- a/changelogs/fragments/288-has_boto3.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- AWS inventory plugins - use shared HAS_BOTO3 helper rather than copying code (https://github.com/ansible-collections/amazon.aws/pull/288). -- AWS lookup plugins - use shared HAS_BOTO3 helper rather than copying code (https://github.com/ansible-collections/amazon.aws/pull/288). diff --git a/changelogs/fragments/291-lint-cleanup.yml b/changelogs/fragments/291-lint-cleanup.yml deleted file mode 100644 index 2da5ac62f8b..00000000000 --- a/changelogs/fragments/291-lint-cleanup.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- module_utils.cloudfront_facts - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). -- module_utils.ec2 - linting cleanup (https://github.com/ansible-collections/amazon.aws/pull/291). diff --git a/changelogs/fragments/295-aws_account_attribute-awsretry.yml b/changelogs/fragments/295-aws_account_attribute-awsretry.yml deleted file mode 100644 index c49f91fdf37..00000000000 --- a/changelogs/fragments/295-aws_account_attribute-awsretry.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- aws_account_attribute - add retries on common AWS failures (https://github.com/ansible-collections/amazon.aws/pull/295). diff --git a/changelogs/fragments/305-ec2_vol-no-platform.yml b/changelogs/fragments/305-ec2_vol-no-platform.yml deleted file mode 100644 index fb9057bcf7c..00000000000 --- a/changelogs/fragments/305-ec2_vol-no-platform.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_vol - fix exception when platform information isn't available (https://github.com/ansible-collections/amazon.aws/issues/305). diff --git a/changelogs/fragments/309-ec2_tags.yml b/changelogs/fragments/309-ec2_tags.yml deleted file mode 100644 index 3d8e47b7c25..00000000000 --- a/changelogs/fragments/309-ec2_tags.yml +++ /dev/null @@ -1,6 +0,0 @@ -minor_changes: -- module_utils/ec2 - added additional helper functions for tagging EC2 resources (https://github.com/ansible-collections/amazon.aws/pull/309). -- ec2_tag - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). -- ec2_tag_info - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). -- ec2_vol - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). -- ec2_vpc_subnet - use common code for tagging resources (https://github.com/ansible-collections/amazon.aws/pull/309). diff --git a/changelogs/fragments/321-ec2_snapshot_info-add_max_results_and_next_token_parameters.yaml b/changelogs/fragments/321-ec2_snapshot_info-add_max_results_and_next_token_parameters.yaml deleted file mode 100644 index 4a97bfd402e..00000000000 --- a/changelogs/fragments/321-ec2_snapshot_info-add_max_results_and_next_token_parameters.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: -- ec2_snapshot_info - add the ``max_results`` along with ``next_token_id`` option (https://github.com/ansible-collections/amazon.aws/pull/321). diff --git a/changelogs/fragments/328_aws_ec2_inventory_includes_entries_matching.yaml b/changelogs/fragments/328_aws_ec2_inventory_includes_entries_matching.yaml deleted file mode 100644 index a2c0c7cdac6..00000000000 --- a/changelogs/fragments/328_aws_ec2_inventory_includes_entries_matching.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: -- "aws_ec2 inventory - expose to new keys called ``include_filters`` and ``exclude_filters`` to give the user the ability to compose an inventory with multiple queries (https://github.com/ansible-collections/amazon.aws/pull/328)." diff --git a/changelogs/fragments/331_aws_ec2_inventory_use_contrib_script_compatible_ec2_tag_keys.yaml b/changelogs/fragments/331_aws_ec2_inventory_use_contrib_script_compatible_ec2_tag_keys.yaml deleted file mode 100644 index 0835e16cd7f..00000000000 --- a/changelogs/fragments/331_aws_ec2_inventory_use_contrib_script_compatible_ec2_tag_keys.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: -- "aws_ec2 inventory - expose a new configuration key ``use_contrib_script_compatible_ec2_tag_keys`` to reproduce a behavior of the old ``ec2.py`` inventory script. With this option enabled, each tag is exposed using a ``ec2_tag_TAGNAME`` key (https://github.com/ansible-collections/amazon.aws/pull/331)." diff --git a/changelogs/fragments/43-ec2_metadata_facts-IMDSv2.yml b/changelogs/fragments/43-ec2_metadata_facts-IMDSv2.yml deleted file mode 100644 index e0ecf9aae7d..00000000000 --- a/changelogs/fragments/43-ec2_metadata_facts-IMDSv2.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_metadata_facts - add support for IMDSv2 (https://github.com/ansible-collections/amazon.aws/pull/43). diff --git a/changelogs/fragments/57-aws_ec2-support-for-templates.yml b/changelogs/fragments/57-aws_ec2-support-for-templates.yml deleted file mode 100644 index 8b986a612f2..00000000000 --- a/changelogs/fragments/57-aws_ec2-support-for-templates.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- "aws_ec2 inventory plugin - Added support for using Jinja2 templates in the authentication fields (https://github.com/ansible-collections/amazon.aws/pull/57)." diff --git a/changelogs/fragments/ignore_212.yml b/changelogs/fragments/ignore_212.yml deleted file mode 100644 index b0a6f4634e0..00000000000 --- a/changelogs/fragments/ignore_212.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- sanity tests - add ignore.txt for 2.12 (https://github.com/ansible-collections/amazon.aws/pull/315). diff --git a/docs/amazon.aws.aws_ec2_inventory.rst b/docs/amazon.aws.aws_ec2_inventory.rst index f92cef2f6ef..f5c25ff9978 100644 --- a/docs/amazon.aws.aws_ec2_inventory.rst +++ b/docs/amazon.aws.aws_ec2_inventory.rst @@ -36,13 +36,13 @@ Parameters - + - - - - - - - - - - - + + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + - + + + + +
ParameterParameter Choices/Defaults Configuration Comments
+
aws_access_key @@ -63,7 +63,7 @@ Parameters
+
aws_profile @@ -83,7 +83,7 @@ Parameters
+
aws_secret_key @@ -104,7 +104,7 @@ Parameters
+
aws_security_token @@ -124,7 +124,7 @@ Parameters
+
cache @@ -149,7 +149,7 @@ Parameters
+
cache_connection @@ -172,7 +172,7 @@ Parameters
+
cache_plugin @@ -196,7 +196,7 @@ Parameters
+
cache_prefix @@ -220,7 +220,7 @@ Parameters
+
cache_timeout @@ -244,7 +244,7 @@ Parameters
+
compose @@ -262,7 +262,28 @@ Parameters
+ +
+ exclude_filters + +
+ list +
+
+ Default:
[]
+
+ +
A list of filters. Any instances matching one of the filters are excluded from the result.
+
The filters from exclude_filters take priority over the include_filters and filters keys
+
Available filters are listed here http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options.
+
Every entry in this list triggers a search query. As such, from a performance point of view, it's better to keep the list as short as possible.
+
filters @@ -281,7 +302,7 @@ Parameters
+
groups @@ -299,7 +320,7 @@ Parameters
+
hostnames @@ -319,7 +340,7 @@ Parameters
+
iam_role_arn @@ -336,7 +357,7 @@ Parameters
+
include_extra_api_calls @@ -358,12 +379,33 @@ Parameters
+ +
+ include_filters + +
+ list +
+
+ Default:
[]
+
+ +
A list of filters. Any instances matching at least one of the filters are included in the result.
+
Available filters are listed here http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options.
+
Every entry in this list triggers a search query. As such, from a performance point of view, it's better to keep the list as short as possible.
+
keyed_groups
list + / elements=dictionary
@@ -374,9 +416,128 @@ Parameters
Add hosts to group based on the values of a variable.
+
+ default_value + +
+ string +
+
added in 2.12
+
+ + +
The default value when the host variable's value is an empty string.
+
This option is mutually exclusive with trailing_separator.
+
+
+ key + +
+ string +
+
+ + +
The key from input dictionary used to generate groups
+
+
+ parent_group + +
+ string +
+
+ + +
parent group for keyed group
+
+
+ prefix + +
+ string +
+
+ Default:
""
+
+ +
A keyed group name will start with this prefix
+
+
+ separator + +
+ string +
+
+ Default:
"_"
+
+ +
separator used to build the keyed group name
+
+
+ trailing_separator + +
+ boolean +
+
added in 2.12
+
+
    Choices: +
  • no
  • +
  • yes ←
  • +
+
+ +
Set this option to False to omit the separator after the host variable when the value is an empty string.
+
This option is mutually exclusive with default_value.
+
leading_separator @@ -400,7 +561,7 @@ Parameters
+
plugin @@ -422,7 +583,7 @@ Parameters
+
regions @@ -441,7 +602,7 @@ Parameters
+
strict @@ -463,7 +624,7 @@ Parameters
+
strict_permissions @@ -485,7 +646,29 @@ Parameters
+ +
+ use_contrib_script_compatible_ec2_tag_keys + +
+ boolean +
+
+
    Choices: +
  • no ←
  • +
  • yes
  • +
+
+ +
Expose the host tags with ec2_tag_TAGNAME keys like the old ec2.py inventory script.
+
The use of this feature is discouraged and we advise to migrate to the new ``tags`` structure.
+
use_contrib_script_compatible_sanitization @@ -508,7 +691,7 @@ Parameters
+
use_extra_vars @@ -558,7 +741,10 @@ Examples # Example using filters, ignoring permission errors, and specifying the hostname precedence plugin: aws_ec2 + # The values for profile, access key, secret key and token can be hardcoded like: boto_profile: aws_profile + # or you could use Jinja as: + # boto_profile: "{{ lookup('env', 'AWS_PROFILE') | default('aws_profile', true) }}" # Populate inventory with instances in these regions regions: - us-east-1 @@ -620,6 +806,20 @@ Examples # (note: this does not modify inventory_hostname, which is set via I(hostnames)) ansible_host: private_ip_address + # Example using include_filters and exclude_filters to compose the inventory. + plugin: aws_ec2 + regions: + - us-east-1 + - us-west-1 + include_filters: + - tag:Name: + - 'my_second_tag' + - tag:Name: + - 'my_third_tag' + exclude_filters: + - tag:Name: + - 'my_first_tag' + diff --git a/docs/amazon.aws.aws_rds_inventory.rst b/docs/amazon.aws.aws_rds_inventory.rst index de00b859f0c..f4bfce290e5 100644 --- a/docs/amazon.aws.aws_rds_inventory.rst +++ b/docs/amazon.aws.aws_rds_inventory.rst @@ -36,13 +36,13 @@ Parameters - + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + + + + diff --git a/docs/amazon.aws.ec2_elb_lb_module.rst b/docs/amazon.aws.ec2_elb_lb_module.rst index 0f26de99982..11b6ca8b8dc 100644 --- a/docs/amazon.aws.ec2_elb_lb_module.rst +++ b/docs/amazon.aws.ec2_elb_lb_module.rst @@ -536,7 +536,7 @@ Parameters diff --git a/docs/amazon.aws.ec2_group_module.rst b/docs/amazon.aws.ec2_group_module.rst index 6472f309219..02d86929a81 100644 --- a/docs/amazon.aws.ec2_group_module.rst +++ b/docs/amazon.aws.ec2_group_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Maintains ec2 security groups. This module has a dependency on python-boto >= 2.5. +- Maintains ec2 security groups. diff --git a/docs/amazon.aws.ec2_metadata_facts_module.rst b/docs/amazon.aws.ec2_metadata_facts_module.rst index 56197455034..56a90cdbcfd 100644 --- a/docs/amazon.aws.ec2_metadata_facts_module.rst +++ b/docs/amazon.aws.ec2_metadata_facts_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_metadata_facts ***************************** -**Gathers facts (instance metadata) about remote hosts within ec2** +**gathers facts (instance metadata) about remote hosts within EC2** Version added: 1.0.0 @@ -17,8 +17,10 @@ Version added: 1.0.0 Synopsis -------- -- This module fetches data from the instance metadata endpoint in ec2 as per https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html. +- This module fetches data from the instance metadata endpoint in EC2 as per https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html. - The module must be called from within the EC2 instance itself. +- The module is configured to utilize the session oriented Instance Metadata Service v2 (IMDSv2) https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html. +- If the HttpEndpoint parameter https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceMetadataOptions.html#API_ModifyInstanceMetadataOptions_RequestParameters is set to disabled for the EC2 instance, the module will return an error while retrieving a session token. @@ -994,7 +996,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a diff --git a/docs/amazon.aws.ec2_snapshot_info_module.rst b/docs/amazon.aws.ec2_snapshot_info_module.rst index 674566651e3..1e58ce9e3e9 100644 --- a/docs/amazon.aws.ec2_snapshot_info_module.rst +++ b/docs/amazon.aws.ec2_snapshot_info_module.rst @@ -163,6 +163,43 @@ Parameters
A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html for possible filters. Filter names and values are case sensitive.
+ + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterParameter Choices/Defaults Configuration Comments
+
aws_access_key @@ -63,7 +63,7 @@ Parameters
+
aws_profile @@ -83,7 +83,7 @@ Parameters
+
aws_secret_key @@ -104,7 +104,7 @@ Parameters
+
aws_security_token @@ -124,7 +124,7 @@ Parameters
+
cache @@ -149,7 +149,7 @@ Parameters
+
cache_connection @@ -172,7 +172,7 @@ Parameters
+
cache_plugin @@ -196,7 +196,7 @@ Parameters
+
cache_prefix @@ -220,7 +220,7 @@ Parameters
+
cache_timeout @@ -244,7 +244,7 @@ Parameters
+
compose @@ -262,7 +262,7 @@ Parameters
+
filters @@ -280,7 +280,7 @@ Parameters
+
groups @@ -298,7 +298,7 @@ Parameters
+
iam_role_arn @@ -315,7 +315,7 @@ Parameters
+
include_clusters @@ -336,12 +336,13 @@ Parameters
+
keyed_groups
list + / elements=dictionary
@@ -352,9 +353,128 @@ Parameters
Add hosts to group based on the values of a variable.
+
+ default_value + +
+ string +
+
added in 2.12
+
+ + +
The default value when the host variable's value is an empty string.
+
This option is mutually exclusive with trailing_separator.
+
+
+ key + +
+ string +
+
+ + +
The key from input dictionary used to generate groups
+
+
+ parent_group + +
+ string +
+
+ + +
parent group for keyed group
+
+
+ prefix + +
+ string +
+
+ Default:
""
+
+ +
A keyed group name will start with this prefix
+
+
+ separator + +
+ string +
+
+ Default:
"_"
+
+ +
separator used to build the keyed group name
+
+
+ trailing_separator + +
+ boolean +
+
added in 2.12
+
+
    Choices: +
  • no
  • +
  • yes ←
  • +
+
+ +
Set this option to False to omit the separator after the host variable when the value is an empty string.
+
This option is mutually exclusive with default_value.
+
leading_separator @@ -378,7 +498,7 @@ Parameters
+
regions @@ -396,7 +516,7 @@ Parameters
+
statuses @@ -414,7 +534,7 @@ Parameters
+
strict @@ -436,7 +556,7 @@ Parameters
+
strict_permissions @@ -457,7 +577,7 @@ Parameters
+
use_extra_vars diff --git a/docs/amazon.aws.cloudformation_module.rst b/docs/amazon.aws.cloudformation_module.rst index 57059af595d..ff6c33e4c08 100644 --- a/docs/amazon.aws.cloudformation_module.rst +++ b/docs/amazon.aws.cloudformation_module.rst @@ -431,7 +431,39 @@ Parameters
-
The path of the CloudFormation stack policy. A policy cannot be removed once placed, but it can be modified. for instance, allow all updates https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051
+
The path of the file containing the CloudFormation stack policy. A policy cannot be removed once placed, but it can be modified. for instance, allow all updates https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051
+
+
+ stack_policy_body + +
+ json +
+
added in 1.5.0
+
+ +
The CloudFormation stack policy in JSON. A policy cannot be removed once placed, but it can be modified. for instance, allow all updates https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051
+
+
+ stack_policy_on_update_body + +
+ json +
+
added in 1.5.0
+
+ +
the body of the cloudformation stack policy only applied during this update.
-
When set to no, SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
-
Metrics. +
Metrics; no longer available.

+
+ max_results + +
+ integer +
+
+ +
The maximum number of snapshot results returned in paginated output.
+
When used only a single page along with a next_token_id response element will be returned.
+
The remaining results of the initial request can be seen by sending another request with the returned next_token_id value.
+
This value can be between 5 and 1000; if next_token_id is given a value larger than 1000, only 1000 results are returned.
+
If this parameter is not used, then DescribeSnapshots returns all results.
+
This parameter is mutually exclusive with snapshot_ids.
+
+
+ next_token_id + +
+ string +
+
+ +
Contains the value returned from a previous paginated request where max_results was used and the results exceeded the value of that parameter.
+
Pagination continues from the end of the previous results that returned the next_token_id value.
+
This parameter is mutually exclusive with snapshot_ids
+
@@ -350,11 +387,44 @@ Common return values are documented `here
KeyKey Returned Description
+
+ next_token_id + +
+ string +
+
when option max_results is set in input +
Contains the value returned from a previous paginated request where max_results was used and the results exceeded the value of that parameter.
+
This value is null when there are no more results to return.
+
+
+
+ snapshots + +
+ list + / elements=dictionary +
+
success +
snapshots retrieved
+
+
 
data_encryption_key_id @@ -365,13 +435,14 @@ Common return values are documented `here
always -
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy.
+
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy.

Sample:
arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456
 
description @@ -389,6 +460,7 @@ Common return values are documented `here
 
encrypted @@ -406,6 +478,7 @@ Common return values are documented `here
 
kms_key_id @@ -416,13 +489,14 @@ Common return values are documented `here
always -
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
+
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Sample:
74c9742a-a1b2-45cb-b3fe-abcdef123456
 
owner_alias @@ -440,6 +514,7 @@ Common return values are documented `here
 
owner_id @@ -457,6 +532,7 @@ Common return values are documented `here
 
progress @@ -474,6 +550,7 @@ Common return values are documented `here
 
snapshot_id @@ -491,6 +568,7 @@ Common return values are documented `here
 
start_time @@ -508,6 +586,7 @@ Common return values are documented `here
 
state @@ -525,6 +604,7 @@ Common return values are documented `here
 
state_message @@ -540,6 +620,7 @@ Common return values are documented `here
 
tags @@ -557,6 +638,7 @@ Common return values are documented `here
 
volume_id @@ -574,6 +656,7 @@ Common return values are documented `here
 
volume_size @@ -590,6 +673,7 @@ Common return values are documented `here 8


@@ -602,3 +686,4 @@ Authors ~~~~~~~ - Rob White (@wimnat) +- Aubin Bikouo (@abikouo) diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst index 06533b86deb..a526eebba89 100644 --- a/docs/amazon.aws.ec2_vol_module.rst +++ b/docs/amazon.aws.ec2_vol_module.rst @@ -19,7 +19,6 @@ Synopsis -------- - Creates an EBS volume and optionally attaches it to an instance. - If both *instance* and *name* are given and the instance has a device at the device name, then no volume is created and no attachment is made. -- This module has a dependency on python-boto. @@ -315,6 +314,26 @@ Parameters

aliases: aws_profile
+
+ purge_tags + +
+ boolean +
+
added in 1.5.0
+
+
    Choices: +
  • no ←
  • +
  • yes
  • +
+
+
Whether to remove existing tags that aren't passed in the tags parameter
+
diff --git a/galaxy.yml b/galaxy.yml index d4de21f141a..d878a7b44ca 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: amazon name: aws -version: 1.4.1 +version: 1.5.0 readme: README.md authors: - Ansible (https://github.com/ansible)