From 013162a952c7b2d11c7e2ebf443d8d4d7a21e95a Mon Sep 17 00:00:00 2001 From: Jill R <4121322+jillr@users.noreply.github.com> Date: Fri, 12 Nov 2021 11:09:50 -0700 Subject: [PATCH] Prep 2.1.0 release (#565) Prep 2.1.0 release SUMMARY Run add_docs, generate changelog ISSUE TYPE Feature Pull Request COMPONENT NAME amazon.aws 2.1 Reviewed-by: Mark Chappell Reviewed-by: None --- CHANGELOG.rst | 49 + README.md | 2 +- changelogs/changelog.yaml | 74 + changelogs/fragments/377-ec2_elb_lb-boto3.yml | 8 - .../430-add_support_for_ipv6_addresses.yml | 4 - ...fix_cloudformation_changeset_detection.yml | 5 - .../fragments/508-s3_bucket-digital_ocean.yml | 2 - .../509-ec2_vol_add_check_mode_support.yml | 3 - ...c2_snapshot_add_check_mode_support.yml.yml | 3 - .../516-ec2_ami_add_check_mode_support.yml | 3 - changelogs/fragments/520-ec2_ami-tagging.yml | 4 - changelogs/fragments/522-ec2_eni-tagging.yml | 2 - .../fragments/523-ec2_vpc_igw-tagging.yml | 2 - .../524-ec2_vpc_nat_gateway-tagging.yml | 2 - .../525-ec2_vpc_endpoint-tagging.yml | 2 - .../526-ec2_instance_search_tags.yml | 2 - .../fragments/527-ec2_instance-tagging.yml | 4 - .../fragments/531-use_tags_handlers.yml | 5 - .../534-ec2_eni_add_check_mode_support.yml | 2 - ...544-vpc-endpoint-add-subnets-sg-option.yml | 3 - changelogs/fragments/548-ec2_key-tagging.yml | 2 - .../fragments/551-ec2_ami-tag-on-create.yml | 2 - .../fragments/552-elb_classic_lb-fact.yml | 3 - .../557-action_group-missing-entry.yml | 2 - docs/amazon.aws.aws_s3_module.rst | 11 +- ...mazon.aws.aws_service_ip_ranges_lookup.rst | 18 + docs/amazon.aws.ec2_elb_lb_module.rst | 832 -------- docs/amazon.aws.ec2_eni_info_module.rst | 6 +- docs/amazon.aws.ec2_key_module.rst | 72 + docs/amazon.aws.ec2_module.rst | 4 +- docs/amazon.aws.ec2_vol_info_module.rst | 7 +- docs/amazon.aws.ec2_vol_module.rst | 1 - ...mazon.aws.ec2_vpc_endpoint_info_module.rst | 2 +- docs/amazon.aws.ec2_vpc_endpoint_module.rst | 36 + docs/amazon.aws.elb_classic_lb_module.rst | 1896 +++++++++++++++++ galaxy.yml | 2 +- 36 files changed, 2168 insertions(+), 909 deletions(-) delete mode 100644 changelogs/fragments/377-ec2_elb_lb-boto3.yml delete mode 100644 changelogs/fragments/430-add_support_for_ipv6_addresses.yml delete mode 100644 changelogs/fragments/507-fix_cloudformation_changeset_detection.yml delete mode 100644 changelogs/fragments/508-s3_bucket-digital_ocean.yml delete mode 100644 changelogs/fragments/509-ec2_vol_add_check_mode_support.yml delete mode 100644 changelogs/fragments/512-ec2_snapshot_add_check_mode_support.yml.yml delete mode 100644 changelogs/fragments/516-ec2_ami_add_check_mode_support.yml delete mode 100644 changelogs/fragments/520-ec2_ami-tagging.yml delete mode 100644 changelogs/fragments/522-ec2_eni-tagging.yml delete mode 100644 changelogs/fragments/523-ec2_vpc_igw-tagging.yml delete mode 100644 changelogs/fragments/524-ec2_vpc_nat_gateway-tagging.yml delete mode 100644 changelogs/fragments/525-ec2_vpc_endpoint-tagging.yml delete mode 100644 changelogs/fragments/526-ec2_instance_search_tags.yml delete mode 100644 changelogs/fragments/527-ec2_instance-tagging.yml delete mode 100644 changelogs/fragments/531-use_tags_handlers.yml delete mode 100644 changelogs/fragments/534-ec2_eni_add_check_mode_support.yml delete mode 100644 changelogs/fragments/544-vpc-endpoint-add-subnets-sg-option.yml delete mode 100644 changelogs/fragments/548-ec2_key-tagging.yml delete mode 100644 changelogs/fragments/551-ec2_ami-tag-on-create.yml delete mode 100644 changelogs/fragments/552-elb_classic_lb-fact.yml delete mode 100644 changelogs/fragments/557-action_group-missing-entry.yml delete mode 100644 docs/amazon.aws.ec2_elb_lb_module.rst create mode 100644 docs/amazon.aws.elb_classic_lb_module.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5bd49f3508b..6f8c5ebd1d3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,55 @@ community.aws Release Notes .. contents:: Topics +v2.1.0 +====== + +Minor Changes +------------- + +- aws_service_ip_ranges - add new option ``ipv6_prefixes`` to get only IPV6 addresses and prefixes for Amazon services (https://github.com/ansible-collections/amazon.aws/pull/430) +- cloudformation - fix detection when there are no changes. Sometimes when there are no changes, the change set will have a status FAILED with StatusReason No updates are to be performed (https://github.com/ansible-collections/amazon.aws/pull/507). +- ec2_ami - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/516). +- ec2_ami - use module_util helper for tagging AMIs (https://github.com/ansible-collections/amazon.aws/pull/520). +- ec2_ami - when creating an AMI from an instance pass the tagging options at creation time (https://github.com/ansible-collections/amazon.aws/pull/551). +- ec2_elb_lb - module renamed to ``elb_classic_lb`` (https://github.com/ansible-collections/amazon.aws/pull/377). +- ec2_eni - add check mode support (https://github.com/ansible-collections/amazon.aws/pull/534). +- ec2_eni - use module_util helper for tagging ENIs (https://github.com/ansible-collections/amazon.aws/pull/522). +- ec2_instance - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/527). +- ec2_key - add support for tagging key pairs (https://github.com/ansible-collections/amazon.aws/pull/548). +- ec2_snapshot - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/512). +- ec2_vol - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/509). +- ec2_vpc_dhcp_option - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). +- ec2_vpc_endpoint - added ``vpc_endpoint_security_groups`` parameter to support defining the security group attached to an interface endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). +- ec2_vpc_endpoint - added ``vpc_endpoint_subnets`` parameter to support defining the subnet attached to an interface or gateway endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). +- ec2_vpc_endpoint - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/525). +- ec2_vpc_endpoint - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). +- ec2_vpc_igw - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/523). +- ec2_vpc_igw - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). +- ec2_vpc_nat_gateway - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/524). +- ec2_vpc_nat_gateway - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). +- elb_classic_lb - added retries on common AWS temporary API failures (https://github.com/ansible-collections/amazon.aws/pull/377). +- elb_classic_lb - added support for check_mode (https://github.com/ansible-collections/amazon.aws/pull/377). +- elb_classic_lb - added support for wait during creation (https://github.com/ansible-collections/amazon.aws/pull/377). +- elb_classic_lb - added support for wait during instance addition and removal (https://github.com/ansible-collections/amazon.aws/pull/377). +- elb_classic_lb - migrated to boto3 SDK (https://github.com/ansible-collections/amazon.aws/pull/377). +- elb_classic_lb - various error messages changed due to refactor (https://github.com/ansible-collections/amazon.aws/pull/377). +- module_utils.ec2 - moved generic tagging helpers into module_utils.tagging (https://github.com/ansible-collections/amazon.aws/pull/527). +- module_utils.tagging - add new helper to generate TagSpecification lists (https://github.com/ansible-collections/amazon.aws/pull/527). + +Deprecated Features +------------------- + +- ec2_classic_lb - setting of the ``ec2_elb`` fact has been deprecated and will be removed in release 4.0.0 of the collection. The module now returns ``elb`` which can be accessed using the register keyword (https://github.com/ansible-collections/amazon.aws/pull/552). + +Bugfixes +-------- + +- AWS action group - added missing ``ec2_instance_facts`` entry (https://github.com/ansible-collections/amazon.aws/issues/557) +- ec2_ami - fix problem when creating an AMI from an instance with ephemeral volumes (https://github.com/ansible-collections/amazon.aws/issues/511). +- ec2_instance - ensure that ec2_instance falls back to the tag(Name) parameter when no filter and no name parameter is passed (https://github.com/ansible-collections/amazon.aws/issues/526). +- s3_bucket - update error handling to better support DigitalOcean Space (https://github.com/ansible-collections/amazon.aws/issues/508). + v2.0.0 ====== diff --git a/README.md b/README.md index 776a5f77983..42040d9e1e6 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,6 @@ Name | Description [amazon.aws.ec2](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_module.rst)|create, terminate, start or stop an instance in ec2 [amazon.aws.ec2_ami](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_ami_module.rst)|Create or destroy an image (AMI) in ec2 [amazon.aws.ec2_ami_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_ami_info_module.rst)|Gather information about ec2 AMIs -[amazon.aws.ec2_elb_lb](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_elb_lb_module.rst)|Creates, updates or destroys an Amazon ELB. [amazon.aws.ec2_eni](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_eni_module.rst)|Create and optionally attach an Elastic Network Interface (ENI) to an instance [amazon.aws.ec2_eni_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_eni_info_module.rst)|Gather information about ec2 ENI interfaces in AWS [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. @@ -81,6 +80,7 @@ Name | Description [amazon.aws.ec2_vpc_route_table_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_route_table_info_module.rst)|Gather information about ec2 VPC route tables in AWS [amazon.aws.ec2_vpc_subnet](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_subnet_module.rst)|Manage subnets in AWS virtual private clouds [amazon.aws.ec2_vpc_subnet_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_subnet_info_module.rst)|Gather information about ec2 VPC subnets in AWS +[amazon.aws.elb_classic_lb](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.elb_classic_lb_module.rst)|creates, updates or destroys an Amazon ELB. [amazon.aws.s3_bucket](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.s3_bucket_module.rst)|Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus, FakeS3 and StorageGRID diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 1785453a503..61572a6fef7 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -520,3 +520,77 @@ releases: name: ec2_spot_instance_info namespace: '' release_date: '2021-09-03' + 2.1.0: + changes: + bugfixes: + - AWS action group - added missing ``ec2_instance_facts`` entry (https://github.com/ansible-collections/amazon.aws/issues/557) + - ec2_ami - fix problem when creating an AMI from an instance with ephemeral + volumes (https://github.com/ansible-collections/amazon.aws/issues/511). + - ec2_instance - ensure that ec2_instance falls back to the tag(Name) parameter + when no filter and no name parameter is passed (https://github.com/ansible-collections/amazon.aws/issues/526). + - s3_bucket - update error handling to better support DigitalOcean Space (https://github.com/ansible-collections/amazon.aws/issues/508). + deprecated_features: + - ec2_classic_lb - setting of the ``ec2_elb`` fact has been deprecated and will + be removed in release 4.0.0 of the collection. The module now returns ``elb`` + which can be accessed using the register keyword (https://github.com/ansible-collections/amazon.aws/pull/552). + minor_changes: + - aws_service_ip_ranges - add new option ``ipv6_prefixes`` to get only IPV6 + addresses and prefixes for Amazon services (https://github.com/ansible-collections/amazon.aws/pull/430) + - cloudformation - fix detection when there are no changes. Sometimes when there + are no changes, the change set will have a status FAILED with StatusReason + No updates are to be performed (https://github.com/ansible-collections/amazon.aws/pull/507). + - ec2_ami - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/516). + - ec2_ami - use module_util helper for tagging AMIs (https://github.com/ansible-collections/amazon.aws/pull/520). + - ec2_ami - when creating an AMI from an instance pass the tagging options at + creation time (https://github.com/ansible-collections/amazon.aws/pull/551). + - ec2_elb_lb - module renamed to ``elb_classic_lb`` (https://github.com/ansible-collections/amazon.aws/pull/377). + - ec2_eni - add check mode support (https://github.com/ansible-collections/amazon.aws/pull/534). + - ec2_eni - use module_util helper for tagging ENIs (https://github.com/ansible-collections/amazon.aws/pull/522). + - ec2_instance - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/527). + - ec2_key - add support for tagging key pairs (https://github.com/ansible-collections/amazon.aws/pull/548). + - ec2_snapshot - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/512). + - ec2_vol - add check_mode support (https://github.com/ansible-collections/amazon.aws/pull/509). + - ec2_vpc_dhcp_option - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). + - ec2_vpc_endpoint - added ``vpc_endpoint_security_groups`` parameter to support + defining the security group attached to an interface endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). + - ec2_vpc_endpoint - added ``vpc_endpoint_subnets`` parameter to support defining + the subnet attached to an interface or gateway endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). + - ec2_vpc_endpoint - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/525). + - ec2_vpc_endpoint - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). + - ec2_vpc_igw - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/523). + - ec2_vpc_igw - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). + - ec2_vpc_nat_gateway - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/524). + - ec2_vpc_nat_gateway - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). + - elb_classic_lb - added retries on common AWS temporary API failures (https://github.com/ansible-collections/amazon.aws/pull/377). + - elb_classic_lb - added support for check_mode (https://github.com/ansible-collections/amazon.aws/pull/377). + - elb_classic_lb - added support for wait during creation (https://github.com/ansible-collections/amazon.aws/pull/377). + - elb_classic_lb - added support for wait during instance addition and removal + (https://github.com/ansible-collections/amazon.aws/pull/377). + - elb_classic_lb - migrated to boto3 SDK (https://github.com/ansible-collections/amazon.aws/pull/377). + - elb_classic_lb - various error messages changed due to refactor (https://github.com/ansible-collections/amazon.aws/pull/377). + - module_utils.ec2 - moved generic tagging helpers into module_utils.tagging + (https://github.com/ansible-collections/amazon.aws/pull/527). + - module_utils.tagging - add new helper to generate TagSpecification lists (https://github.com/ansible-collections/amazon.aws/pull/527). + fragments: + - 377-ec2_elb_lb-boto3.yml + - 430-add_support_for_ipv6_addresses.yml + - 507-fix_cloudformation_changeset_detection.yml + - 508-s3_bucket-digital_ocean.yml + - 509-ec2_vol_add_check_mode_support.yml + - 512-ec2_snapshot_add_check_mode_support.yml.yml + - 516-ec2_ami_add_check_mode_support.yml + - 520-ec2_ami-tagging.yml + - 522-ec2_eni-tagging.yml + - 523-ec2_vpc_igw-tagging.yml + - 524-ec2_vpc_nat_gateway-tagging.yml + - 525-ec2_vpc_endpoint-tagging.yml + - 526-ec2_instance_search_tags.yml + - 527-ec2_instance-tagging.yml + - 531-use_tags_handlers.yml + - 534-ec2_eni_add_check_mode_support.yml + - 544-vpc-endpoint-add-subnets-sg-option.yml + - 548-ec2_key-tagging.yml + - 551-ec2_ami-tag-on-create.yml + - 552-elb_classic_lb-fact.yml + - 557-action_group-missing-entry.yml + release_date: '2021-11-11' diff --git a/changelogs/fragments/377-ec2_elb_lb-boto3.yml b/changelogs/fragments/377-ec2_elb_lb-boto3.yml deleted file mode 100644 index e32a65a12ce..00000000000 --- a/changelogs/fragments/377-ec2_elb_lb-boto3.yml +++ /dev/null @@ -1,8 +0,0 @@ -minor_changes: -- ec2_elb_lb - module renamed to ``elb_classic_lb`` (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - migrated to boto3 SDK (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - added support for check_mode (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - added support for wait during creation (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - added support for wait during instance addition and removal (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - added retries on common AWS temporary API failures (https://github.com/ansible-collections/amazon.aws/pull/377). -- elb_classic_lb - various error messages changed due to refactor (https://github.com/ansible-collections/amazon.aws/pull/377). diff --git a/changelogs/fragments/430-add_support_for_ipv6_addresses.yml b/changelogs/fragments/430-add_support_for_ipv6_addresses.yml deleted file mode 100644 index b05ea9effcf..00000000000 --- a/changelogs/fragments/430-add_support_for_ipv6_addresses.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: - - aws_service_ip_ranges - add new option ``ipv6_prefixes`` - to get only IPV6 addresses and prefixes for Amazon services - (https://github.com/ansible-collections/amazon.aws/pull/430) diff --git a/changelogs/fragments/507-fix_cloudformation_changeset_detection.yml b/changelogs/fragments/507-fix_cloudformation_changeset_detection.yml deleted file mode 100644 index b9c819b0e13..00000000000 --- a/changelogs/fragments/507-fix_cloudformation_changeset_detection.yml +++ /dev/null @@ -1,5 +0,0 @@ -minor_changes: - - cloudformation - fix detection when there are no changes. - Sometimes when there are no changes, the change set will have a status FAILED with StatusReason - No updates are to be performed - (https://github.com/ansible-collections/amazon.aws/pull/507). diff --git a/changelogs/fragments/508-s3_bucket-digital_ocean.yml b/changelogs/fragments/508-s3_bucket-digital_ocean.yml deleted file mode 100644 index e38b5e7340e..00000000000 --- a/changelogs/fragments/508-s3_bucket-digital_ocean.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- s3_bucket - update error handling to better support DigitalOcean Space (https://github.com/ansible-collections/amazon.aws/issues/508). diff --git a/changelogs/fragments/509-ec2_vol_add_check_mode_support.yml b/changelogs/fragments/509-ec2_vol_add_check_mode_support.yml deleted file mode 100644 index 7c009d578c9..00000000000 --- a/changelogs/fragments/509-ec2_vol_add_check_mode_support.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - ec2_vol - add check_mode support - (https://github.com/ansible-collections/amazon.aws/pull/509). diff --git a/changelogs/fragments/512-ec2_snapshot_add_check_mode_support.yml.yml b/changelogs/fragments/512-ec2_snapshot_add_check_mode_support.yml.yml deleted file mode 100644 index acc069ad913..00000000000 --- a/changelogs/fragments/512-ec2_snapshot_add_check_mode_support.yml.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - ec2_snapshot - add check_mode support - (https://github.com/ansible-collections/amazon.aws/pull/512). diff --git a/changelogs/fragments/516-ec2_ami_add_check_mode_support.yml b/changelogs/fragments/516-ec2_ami_add_check_mode_support.yml deleted file mode 100644 index 7511f2fac3c..00000000000 --- a/changelogs/fragments/516-ec2_ami_add_check_mode_support.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - ec2_ami - add check_mode support - (https://github.com/ansible-collections/amazon.aws/pull/516). diff --git a/changelogs/fragments/520-ec2_ami-tagging.yml b/changelogs/fragments/520-ec2_ami-tagging.yml deleted file mode 100644 index 275c0117213..00000000000 --- a/changelogs/fragments/520-ec2_ami-tagging.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- ec2_ami - use module_util helper for tagging AMIs (https://github.com/ansible-collections/amazon.aws/pull/520). -bugfixes: -- ec2_ami - fix problem when creating an AMI from an instance with ephemeral volumes (https://github.com/ansible-collections/amazon.aws/issues/511). diff --git a/changelogs/fragments/522-ec2_eni-tagging.yml b/changelogs/fragments/522-ec2_eni-tagging.yml deleted file mode 100644 index 3af277f5c0d..00000000000 --- a/changelogs/fragments/522-ec2_eni-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_eni - use module_util helper for tagging ENIs (https://github.com/ansible-collections/amazon.aws/pull/522). diff --git a/changelogs/fragments/523-ec2_vpc_igw-tagging.yml b/changelogs/fragments/523-ec2_vpc_igw-tagging.yml deleted file mode 100644 index 7486cd26464..00000000000 --- a/changelogs/fragments/523-ec2_vpc_igw-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ec2_vpc_igw - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/523). diff --git a/changelogs/fragments/524-ec2_vpc_nat_gateway-tagging.yml b/changelogs/fragments/524-ec2_vpc_nat_gateway-tagging.yml deleted file mode 100644 index 1172f39ab8c..00000000000 --- a/changelogs/fragments/524-ec2_vpc_nat_gateway-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ec2_vpc_nat_gateway - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/524). diff --git a/changelogs/fragments/525-ec2_vpc_endpoint-tagging.yml b/changelogs/fragments/525-ec2_vpc_endpoint-tagging.yml deleted file mode 100644 index eb6fc13956d..00000000000 --- a/changelogs/fragments/525-ec2_vpc_endpoint-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ec2_vpc_endpoint - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/525). diff --git a/changelogs/fragments/526-ec2_instance_search_tags.yml b/changelogs/fragments/526-ec2_instance_search_tags.yml deleted file mode 100644 index de4dd6c8697..00000000000 --- a/changelogs/fragments/526-ec2_instance_search_tags.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_instance - ensure that ec2_instance falls back to the tag(Name) parameter when no filter and no name parameter is passed (https://github.com/ansible-collections/amazon.aws/issues/526). diff --git a/changelogs/fragments/527-ec2_instance-tagging.yml b/changelogs/fragments/527-ec2_instance-tagging.yml deleted file mode 100644 index 8ff05be37fa..00000000000 --- a/changelogs/fragments/527-ec2_instance-tagging.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- ec2_instance - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/527). -- module_utils.tagging - add new helper to generate TagSpecification lists (https://github.com/ansible-collections/amazon.aws/pull/527). -- module_utils.ec2 - moved generic tagging helpers into module_utils.tagging (https://github.com/ansible-collections/amazon.aws/pull/527). diff --git a/changelogs/fragments/531-use_tags_handlers.yml b/changelogs/fragments/531-use_tags_handlers.yml deleted file mode 100644 index 44ae6c59c33..00000000000 --- a/changelogs/fragments/531-use_tags_handlers.yml +++ /dev/null @@ -1,5 +0,0 @@ -minor_changes: - - ec2_vpc_nat_gateway - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). - - ec2_vpc_igw - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). - - ec2_vpc_dhcp_option - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). - - ec2_vpc_endpoint - use module_util helpers for tagging (https://github.com/ansible-collections/amazon.aws/pull/531). diff --git a/changelogs/fragments/534-ec2_eni_add_check_mode_support.yml b/changelogs/fragments/534-ec2_eni_add_check_mode_support.yml deleted file mode 100644 index c33a9586d88..00000000000 --- a/changelogs/fragments/534-ec2_eni_add_check_mode_support.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_eni - add check mode support (https://github.com/ansible-collections/amazon.aws/pull/534). diff --git a/changelogs/fragments/544-vpc-endpoint-add-subnets-sg-option.yml b/changelogs/fragments/544-vpc-endpoint-add-subnets-sg-option.yml deleted file mode 100644 index 4c68f502194..00000000000 --- a/changelogs/fragments/544-vpc-endpoint-add-subnets-sg-option.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- ec2_vpc_endpoint - added ``vpc_endpoint_subnets`` parameter to support defining the subnet attached to an interface or gateway endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). -- ec2_vpc_endpoint - added ``vpc_endpoint_security_groups`` parameter to support defining the security group attached to an interface endpoint (https://github.com/ansible-collections/amazon.aws/pull/544). diff --git a/changelogs/fragments/548-ec2_key-tagging.yml b/changelogs/fragments/548-ec2_key-tagging.yml deleted file mode 100644 index 24b0382b295..00000000000 --- a/changelogs/fragments/548-ec2_key-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_key - add support for tagging key pairs (https://github.com/ansible-collections/amazon.aws/pull/548). diff --git a/changelogs/fragments/551-ec2_ami-tag-on-create.yml b/changelogs/fragments/551-ec2_ami-tag-on-create.yml deleted file mode 100644 index 22403e449d7..00000000000 --- a/changelogs/fragments/551-ec2_ami-tag-on-create.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_ami - when creating an AMI from an instance pass the tagging options at creation time (https://github.com/ansible-collections/amazon.aws/pull/551). diff --git a/changelogs/fragments/552-elb_classic_lb-fact.yml b/changelogs/fragments/552-elb_classic_lb-fact.yml deleted file mode 100644 index 1b63ad0541d..00000000000 --- a/changelogs/fragments/552-elb_classic_lb-fact.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- ec2_classic_lb - setting of the ``ec2_elb`` fact has been deprecated and will be removed in release 4.0.0 of the collection. - The module now returns ``elb`` which can be accessed using the register keyword (https://github.com/ansible-collections/amazon.aws/pull/552). diff --git a/changelogs/fragments/557-action_group-missing-entry.yml b/changelogs/fragments/557-action_group-missing-entry.yml deleted file mode 100644 index b9b3dd48996..00000000000 --- a/changelogs/fragments/557-action_group-missing-entry.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- AWS action group - added missing ``ec2_instance_facts`` entry (https://github.com/ansible-collections/amazon.aws/issues/557) diff --git a/docs/amazon.aws.aws_s3_module.rst b/docs/amazon.aws.aws_s3_module.rst index 66990d6fbff..2ec80a8df56 100644 --- a/docs/amazon.aws.aws_s3_module.rst +++ b/docs/amazon.aws.aws_s3_module.rst @@ -474,7 +474,16 @@ Parameters -
Switches the module behaviour between PUT (upload), GET (download), geturl (return download URL, Ansible 1.3+), getstr (download object as string (1.3+)), list (list keys, Ansible 2.0+), create (bucket), delete (bucket), delobj (delete object, Ansible 2.0+) and copy object that is already stored in another (bucket).
+
Switches the module behaviour between
+
PUT: upload
+
GET: download
+
geturl: return download URL
+
getstr: download object as string
+
list: list keys
+
create: create bucket
+
delete: delete bucket
+
delobj: delete object
+
copy: copy object that is already stored in another bucket
diff --git a/docs/amazon.aws.aws_service_ip_ranges_lookup.rst b/docs/amazon.aws.aws_service_ip_ranges_lookup.rst index 194929b4f9c..0b013757981 100644 --- a/docs/amazon.aws.aws_service_ip_ranges_lookup.rst +++ b/docs/amazon.aws.aws_service_ip_ranges_lookup.rst @@ -40,6 +40,24 @@ Parameters Configuration Comments + + +
+ ipv6_prefixes + +
+ - +
+
added in 2.1.0
+ + + + + + +
When ipv6_prefixes=True the lookup will return ipv6 addresses instead of ipv4 addresses
+ +
diff --git a/docs/amazon.aws.ec2_elb_lb_module.rst b/docs/amazon.aws.ec2_elb_lb_module.rst deleted file mode 100644 index f1050582b29..00000000000 --- a/docs/amazon.aws.ec2_elb_lb_module.rst +++ /dev/null @@ -1,832 +0,0 @@ -.. _amazon.aws.ec2_elb_lb_module: - - -********************* -amazon.aws.ec2_elb_lb -********************* - -**Creates, updates or destroys an Amazon ELB.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Returns information about the load balancer. -- Will be marked changed when called only if state is changed. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- boto -- boto3 >= 1.15.0 -- botocore >= 1.18.0 -- python >= 2.6 -- python >= 3.6 - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- access_logs - -
- dictionary -
- 		- -
An associative array of access logs configuration settings (see examples).
-
-
- aws_access_key - -
- string -
- 		- -
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
-
If profile is set this parameter is ignored.
-
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
-

aliases: ec2_access_key, access_key
-
-
- aws_ca_bundle - -
- path -
- 		- -
The location of a CA Bundle to use when validating SSL certificates.
-
Not used by boto 2 based modules.
-
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
-
-
- aws_config - -
- dictionary -
- 		- -
A dictionary to modify the botocore configuration.
- -
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
-
-
- aws_secret_key - -
- string -
- 		- -
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
-
If profile is set this parameter is ignored.
-
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
-

aliases: ec2_secret_key, secret_key
-
-
- connection_draining_timeout - -
- integer -
- 		- -
Wait a specified timeout allowing connections to drain before terminating an instance.
-
-
- cross_az_load_balancing - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Distribute load across all configured Availability Zones.
-
Defaults to false.
-
-
- debug_botocore_endpoint_logs - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
-
-
- ec2_url - -
- string -
- 		- -
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
-

aliases: aws_endpoint_url, endpoint_url
-
-
- health_check - -
- dictionary -
- 		- -
An associative array of health check configuration settings (see examples).
-
-
- idle_timeout - -
- integer -
- 		- -
ELB connections from clients and to servers are timed out after this amount of time.
-
-
- instance_ids - -
- list - / elements=string -
- 		- -
List of instance ids to attach to this ELB.
-
-
- listeners - -
- list - / elements=dictionary -
- 		- -
List of ports/protocols for this ELB to listen on (see examples).
-
-
- name - -
- string - / required -
- 		- -
The name of the ELB.
-
-
- profile - -
- string -
- 		- -
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
-
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
-

aliases: aws_profile
-
-
- purge_instance_ids - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing instance ids on ELB that are not found in instance_ids.
-
-
- purge_listeners - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Purge existing listeners on ELB that are not found in listeners.
-
-
- purge_subnets - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing subnet on ELB that are not found in subnets.
-
-
- purge_zones - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Purge existing availability zones on ELB that are not found in zones.
-
-
- region - -
- string -
- 		- -
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
-

aliases: aws_region, ec2_region
-
-
- scheme - -
- string -
- 		-
    Choices: -
  • internal
    • -
  • internet-facing ←
    • -
- 		-
The scheme to use when creating the ELB. For a private VPC-visible ELB use internal.
-
If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must use the option wait.
-
-
- security_group_ids - -
- list - / elements=string -
- 		- -
A list of security groups to apply to the ELB.
-
-
- security_group_names - -
- list - / elements=string -
- 		- -
A list of security group names to apply to the ELB.
-
-
- security_token - -
- string -
- 		- -
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
-
If profile is set this parameter is ignored.
-
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
-

aliases: aws_security_token, access_token
-
-
- state - -
- string - / required -
- 		-
    Choices: -
  • absent
    • -
  • present
    • -
- 		-
Create or destroy the ELB.
-
-
- stickiness - -
- dictionary -
- 		- -
An associative array of stickiness policy settings. Policy will be applied to all listeners (see examples).
-
-
- subnets - -
- list - / elements=string -
- 		- -
A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
-
-
- tags - -
- dictionary -
- 		- -
An associative array of tags. To delete all tags, supply an empty dict ({}).
-
-
- validate_certs - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
-
- wait - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
-
-
- wait_timeout - -
- integer -
- 		- Default:
60
- 		-
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated.
-
A maximum of 600 seconds (10 minutes) is allowed.
-
-
- zones - -
- list - / elements=string -
- 		- -
List of availability zones to enable on this ELB.
-
-
- - -Notes ------ - -.. note:: - - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. - - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. - - - -Examples --------- - -.. code-block:: yaml - - # Note: None of these examples set aws_access_key, aws_secret_key, or region. - # It is assumed that their matching environment variables are set. - - # Basic provisioning example (non-VPC) - - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http # options are http, https, ssl, tcp - load_balancer_port: 80 - instance_port: 80 - proxy_protocol: True - - protocol: https - load_balancer_port: 443 - instance_protocol: http # optional, defaults to value of protocol setting - instance_port: 80 - # ssl certificate required for https or ssl - ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert" - - # Internal ELB example - - - amazon.aws.ec2_elb_lb: - name: "test-vpc" - scheme: internal - state: present - instance_ids: - - i-abcd1234 - purge_instance_ids: true - subnets: - - subnet-abcd1234 - - subnet-1a2b3c4d - listeners: - - protocol: http # options are http, https, ssl, tcp - load_balancer_port: 80 - instance_port: 80 - - # Configure a health check and the access logs - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - health_check: - ping_protocol: http # options are http, https, ssl, tcp - ping_port: 80 - ping_path: "/index.html" # not required for tcp or ssl - response_timeout: 5 # seconds - interval: 30 # seconds - unhealthy_threshold: 2 - healthy_threshold: 10 - access_logs: - interval: 5 # minutes (defaults to 60) - s3_location: "my-bucket" # This value is required if access_logs is set - s3_prefix: "logs" - - # Ensure ELB is gone - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: absent - - # Ensure ELB is gone and wait for check (for default timeout) - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: absent - wait: yes - - # Ensure ELB is gone and wait for check with timeout value - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: absent - wait: yes - wait_timeout: 600 - - # Normally, this module will purge any listeners that exist on the ELB - # but aren't specified in the listeners parameter. If purge_listeners is - # false it leaves them alone - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - purge_listeners: no - - # Normally, this module will leave availability zones that are enabled - # on the ELB alone. If purge_zones is true, then any extraneous zones - # will be removed - - amazon.aws.ec2_elb_lb: - name: "test-please-delete" - state: present - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - purge_zones: yes - - # Creates a ELB and assigns a list of subnets to it. - - amazon.aws.ec2_elb_lb: - state: present - name: 'New ELB' - security_group_ids: 'sg-123456, sg-67890' - region: us-west-2 - subnets: 'subnet-123456,subnet-67890' - purge_subnets: yes - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - - # Create an ELB with connection draining, increased idle timeout and cross availability - # zone load balancing - - amazon.aws.ec2_elb_lb: - name: "New ELB" - state: present - connection_draining_timeout: 60 - idle_timeout: 300 - cross_az_load_balancing: "yes" - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - - # Create an ELB with load balancer stickiness enabled - - amazon.aws.ec2_elb_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - stickiness: - type: loadbalancer - enabled: yes - expiration: 300 - - # Create an ELB with application stickiness enabled - - amazon.aws.ec2_elb_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - stickiness: - type: application - enabled: yes - cookie: SESSIONID - - # Create an ELB and add tags - - amazon.aws.ec2_elb_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - tags: - Name: "New ELB" - stack: "production" - client: "Bob" - - # Delete all tags from an ELB - - amazon.aws.ec2_elb_lb: - name: "New ELB" - state: present - region: us-east-1 - zones: - - us-east-1a - - us-east-1d - listeners: - - protocol: http - load_balancer_port: 80 - instance_port: 80 - tags: {} - - - - -Status ------- - - -Authors -~~~~~~~ - -- Jim Dalton (@jsdalton) diff --git a/docs/amazon.aws.ec2_eni_info_module.rst b/docs/amazon.aws.ec2_eni_info_module.rst index 67d2f984570..a37d601797d 100644 --- a/docs/amazon.aws.ec2_eni_info_module.rst +++ b/docs/amazon.aws.ec2_eni_info_module.rst @@ -478,7 +478,8 @@ Common return values are documented `here string -
added in 1.3.0
+
added in 1.3.0
+ When a Name tag has been set
The Name tag of the ENI, often displayed in the AWS UIs as Name
@@ -684,7 +685,8 @@ Common return values are documented `here dictionary -
added in 1.3.0
+
added in 1.3.0
+ always
Dictionary of tags added to the ENI
diff --git a/docs/amazon.aws.ec2_key_module.rst b/docs/amazon.aws.ec2_key_module.rst index 424d9090239..1f5e5ba91c4 100644 --- a/docs/amazon.aws.ec2_key_module.rst +++ b/docs/amazon.aws.ec2_key_module.rst @@ -213,6 +213,26 @@ Parameters

aliases: aws_profile
+ + +
+ purge_tags + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Delete any tags not specified in tags.
+ +
@@ -266,6 +286,22 @@ Parameters
create or delete keypair
+ + +
+ tags + +
+ dictionary +
+
added in 2.1.0
+ + + + +
A dictionary of tags to set on the key pair.
+ +
@@ -432,6 +468,24 @@ Common return values are documented `here b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43 + +   + +
+ id + +
+ string +
+ + when state is present + +
id of the keypair
+
+
Sample:
+
key-123456789abc
+ +   @@ -468,6 +522,24 @@ Common return values are documented `here -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKC... -----END RSA PRIVATE KEY----- + +   + +
+ tags + +
+ dictionary +
+ + when state is present + +
a dictionary representing the tags attached to the key pair
+
+
Sample:
+
{"my_key": "my value"}
+ + diff --git a/docs/amazon.aws.ec2_module.rst b/docs/amazon.aws.ec2_module.rst index d4d1dae3e2c..c356a876691 100644 --- a/docs/amazon.aws.ec2_module.rst +++ b/docs/amazon.aws.ec2_module.rst @@ -18,7 +18,7 @@ DEPRECATED ---------- :Removed in collection release after :Why: The ec2 module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`ec2_instance `. +:Alternative: Use :ref:`amazon.aws.ec2_instance `. @@ -660,7 +660,7 @@ Parameters -
Create, terminate, start, stop or restart instances. The state 'restarted' was added in Ansible 2.2.
+
Create, terminate, start, stop or restart instances.
When state=absent, instance_ids is required.
When state=running, state=stopped or state=restarted then either instance_ids or instance_tags is required.
diff --git a/docs/amazon.aws.ec2_vol_info_module.rst b/docs/amazon.aws.ec2_vol_info_module.rst index 5e98be72a5c..3310b7b5837 100644 --- a/docs/amazon.aws.ec2_vol_info_module.rst +++ b/docs/amazon.aws.ec2_vol_info_module.rst @@ -280,7 +280,6 @@ Examples amazon.aws.ec2_vol_info: filters: attachment.instance-id: "i-000111222333" - region: "us-east-1" register: volumes @@ -320,15 +319,17 @@ Common return values are documented `here attachment_set
- dictionary + list + / elements=dictionary
Information about the volume attachments.
+
This was changed in version 2.0.0 from a dictionary to a list of dictionaries.

Sample:
-
{'attach_time': '2015-10-23T00:22:29.000Z', 'deleteOnTermination': 'false', 'device': '/dev/sdf', 'instance_id': 'i-8356263c', 'status': 'attached'}
+
[{'attach_time': '2015-10-23T00:22:29.000Z', 'deleteOnTermination': 'false', 'device': '/dev/sdf', 'instance_id': 'i-8356263c', 'status': 'attached'}]
diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst index 60f75fe71ed..5ab132d875b 100644 --- a/docs/amazon.aws.ec2_vol_module.rst +++ b/docs/amazon.aws.ec2_vol_module.rst @@ -589,7 +589,6 @@ Examples # Example: Launch an instance and then add a volume if not already attached # * Volume will be created with the given name if not already created. # * Nothing will happen if the volume is already attached. - # * Requires Ansible 2.0 - amazon.aws.ec2: keypair: "{{ keypair }}" diff --git a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst index bcbf776d7d1..cc4b16d54c6 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst @@ -198,7 +198,7 @@ Parameters
Defaults to endpoints.
Specifies the query action to take.
query=endpoints returns information about AWS VPC endpoints.
-
Retrieving information about services using query=services has been deprecated in favour of the ec2_vpc_endpoint_service_info module.
+
Retrieving information about services using query=services has been deprecated in favour of the amazon.aws.ec2_vpc_endpoint_service_info module.
The query option has been deprecated and will be removed after 2022-12-01.
diff --git a/docs/amazon.aws.ec2_vpc_endpoint_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_module.rst index 49168cd9ea6..60e1d25169e 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_module.rst @@ -371,6 +371,42 @@ Parameters
One or more vpc endpoint ids to remove from the AWS account
+ + +
+ vpc_endpoint_security_groups + +
+ list + / elements=string +
+
added in 2.1.0
+ + + + +
The list of security groups to attach to the endpoint.
+
Requires vpc_endpoint_type=GatewayLoadBalancer or vpc_endpoint_type=Interface.
+ + + + +
+ vpc_endpoint_subnets + +
+ list + / elements=string +
+
added in 2.1.0
+ + + + +
The list of subnets to attach to the endpoint.
+
Requires vpc_endpoint_type=GatewayLoadBalancer or vpc_endpoint_type=Interface.
+ +
diff --git a/docs/amazon.aws.elb_classic_lb_module.rst b/docs/amazon.aws.elb_classic_lb_module.rst new file mode 100644 index 00000000000..32176e2d370 --- /dev/null +++ b/docs/amazon.aws.elb_classic_lb_module.rst @@ -0,0 +1,1896 @@ +.. _amazon.aws.elb_classic_lb_module: + + +************************* +amazon.aws.elb_classic_lb +************************* + +**creates, updates or destroys an Amazon ELB.** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Creates, updates or destroys an Amazon Elastic Load Balancer (ELB). +- This module was renamed from ``amazon.aws.ec2_elb_lb`` to :ref:`amazon.aws.elb_classic_lb ` in version 2.1.0 of the amazon.aws collection. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ access_logs + +
+ dictionary +
+ 		+ +
A dictionary of access logs configuration settings (see examples).
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to True will configure delivery of access logs to an S3 bucket.
+
When set to False will disable delivery of access logs.
+
+
+ interval + +
+ integer +
+ 		+
    Choices: +
  • 5
    • +
  • 60 ←
    • +
+ 		+
The interval for publishing the access logs to S3.
+
+
+ s3_location + +
+ string +
+ 		+ +
The S3 bucket to deliver access logs to.
+
See https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html for more information about the necessary S3 bucket policies.
+
Required when enabled=True.
+
+
+ s3_prefix + +
+ string +
+ 		+ Default:
""
+ 		+
Where in the S3 bucket to deliver the logs.
+
If the prefix is not provided or set to "", the log is placed at the root level of the bucket.
+
+
+ aws_access_key + +
+ string +
+ 		+ +
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

aliases: ec2_access_key, access_key
+
+
+ aws_ca_bundle + +
+ path +
+ 		+ +
The location of a CA Bundle to use when validating SSL certificates.
+
Not used by boto 2 based modules.
+
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+
+
+ aws_config + +
+ dictionary +
+ 		+ +
A dictionary to modify the botocore configuration.
+ +
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
+
+
+ aws_secret_key + +
+ string +
+ 		+ +
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

aliases: ec2_secret_key, secret_key
+
+
+ connection_draining_timeout + +
+ integer +
+ 		+ +
Wait a specified timeout allowing connections to drain before terminating an instance.
+
Set to 0 to disable connection draining.
+
+
+ cross_az_load_balancing + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Distribute load across all configured Availability Zones.
+
Defaults to false.
+
+
+ debug_botocore_endpoint_logs + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
+
+
+ ec2_url + +
+ string +
+ 		+ +
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
+

aliases: aws_endpoint_url, endpoint_url
+
+
+ health_check + +
+ dictionary +
+ 		+ +
A dictionary of health check configuration settings (see examples).
+
+
+ healthy_threshold + +
+ integer + / required +
+ 		+ +
The number of consecutive health checks successes required before moving the instance to the Healthy state.
+
+
+ interval + +
+ integer + / required +
+ 		+ +
The approximate interval, in seconds, between health checks of an individual instance.
+
+
+ ping_path + +
+ string +
+ 		+ +
The URI path which the ELB health check will query when performing a health check.
+
Required when ping_protocol=HTTP or ping_protocol=HTTPS.
+
+
+ ping_port + +
+ integer + / required +
+ 		+ +
The TCP port to which the ELB will connect when performing a health check.
+
+
+ ping_protocol + +
+ string + / required +
+ 		+ +
The protocol which the ELB health check will use when performing a health check.
+
Valid values are 'HTTP', 'HTTPS', 'TCP' and 'SSL'.
+
+
+ timeout + +
+ integer + / required +
+ 		+ +
The amount of time, in seconds, after which no response means a failed health check.
+

aliases: response_timeout
+
+
+ unhealthy_threshold + +
+ integer + / required +
+ 		+ +
The number of consecutive health check failures required before moving the instance to the Unhealthy state.
+
+
+ idle_timeout + +
+ integer +
+ 		+ +
ELB connections from clients and to servers are timed out after this amount of time.
+
+
+ instance_ids + +
+ list + / elements=string +
+ 		+ +
List of instance ids to attach to this ELB.
+
+
+ listeners + +
+ list + / elements=dictionary +
+ 		+ +
List of ports/protocols for this ELB to listen on (see examples).
+
Required when state=present and the ELB doesn't exist.
+
+
+ instance_port + +
+ integer + / required +
+ 		+ +
The port on which the instance is listening.
+
+
+ instance_protocol + +
+ string +
+ 		+ +
The protocol to use for routing traffic to instances.
+
Valid values are HTTP, HTTPS, TCP, or SSL,
+
+
+ load_balancer_port + +
+ integer + / required +
+ 		+ +
The port on which the load balancer will listen.
+
+
+ protocol + +
+ string + / required +
+ 		+ +
The transport protocol to use for routing.
+
Valid values are HTTP, HTTPS, TCP, or SSL.
+
+
+ proxy_protocol + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Enable proxy protocol for the listener.
+
Beware, ELB controls for the proxy protocol are based on the instance_port. If you have multiple listeners talking to the same instance_port, this will affect all of them.
+
+
+ ssl_certificate_id + +
+ string +
+ 		+ +
The Amazon Resource Name (ARN) of the SSL certificate.
+
+
+ name + +
+ string + / required +
+ 		+ +
The name of the ELB.
+
The name of an ELB must be less than 32 characters and unique per-region per-account.
+
+
+ profile + +
+ string +
+ 		+ +
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
+
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+

aliases: aws_profile
+
+
+ purge_instance_ids + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing instance ids on ELB that are not found in instance_ids.
+
+
+ purge_listeners + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Purge existing listeners on ELB that are not found in listeners.
+
+
+ purge_subnets + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing subnets on the ELB that are not found in subnets.
+
Because it is not permitted to add multiple subnets from the same availability zone, subnets to be purged will be removed before new subnets are added. This may cause a brief outage if you try to replace all subnets at once.
+
+
+ purge_tags + +
+ boolean +
+
added in 2.1.0
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
Whether to remove existing tags that aren't passed in the tags parameter.
+
+
+ purge_zones + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
Purge existing availability zones on ELB that are not found in zones.
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ scheme + +
+ string +
+ 		+
    Choices: +
  • internal
    • +
  • internet-facing
    • +
+ 		+
The scheme to use when creating the ELB.
+
For a private VPC-visible ELB use internal.
+
If you choose to update your scheme with a different value the ELB will be destroyed and a new ELB created.
+
Defaults to scheme=internet-facing.
+
+
+ security_group_ids + +
+ list + / elements=string +
+ 		+ +
A list of security groups to apply to the ELB.
+
+
+ security_group_names + +
+ list + / elements=string +
+ 		+ +
A list of security group names to apply to the ELB.
+
+
+ security_token + +
+ string +
+ 		+ +
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

aliases: aws_security_token, access_token
+
+
+ state + +
+ string + / required +
+ 		+
    Choices: +
  • absent
    • +
  • present
    • +
+ 		+
Create or destroy the ELB.
+
+
+ stickiness + +
+ dictionary +
+ 		+ +
A dictionary of stickiness policy settings.
+
Policy will be applied to all listeners (see examples).
+
+
+ cookie + +
+ string +
+ 		+ +
The name of the application cookie used for stickiness.
+
Required if enabled=true and type=application.
+
Ignored if enabled=false.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When enabled=false session stickiness will be disabled for all listeners.
+
+
+ expiration + +
+ integer +
+ 		+ +
The time period, in seconds, after which the cookie should be considered stale.
+
If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
+
Ignored if enabled=false.
+
+
+ type + +
+ string +
+ 		+
    Choices: +
  • application
    • +
  • loadbalancer
    • +
+ 		+
The type of stickiness policy to apply.
+
Required if enabled=true.
+
Ignored if enabled=false.
+
+
+ subnets + +
+ list + / elements=string +
+ 		+ +
A list of VPC subnets to use when creating the ELB.
+
Mutually exclusive with zones.
+
+
+ tags + +
+ dictionary +
+ 		+ +
A dictionary of tags to apply to the ELB.
+
To delete all tags supply an empty dict ({}) and set purge_tags=true.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+
+ wait + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When creating, deleting, or adding instances to an ELB, if wait=true Ansible will wait for both the load balancer and related network interfaces to finish creating/deleting.
+
Support for waiting when adding instances was added in release 2.1.0.
+
+
+ wait_timeout + +
+ integer +
+ 		+ Default:
180
+ 		+
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated.
+
A maximum of 600 seconds (10 minutes) is allowed.
+
+
+ zones + +
+ list + / elements=string +
+ 		+ +
List of availability zones to enable on this ELB.
+
Mutually exclusive with subnets.
+
+
+ + +Notes +----- + +.. note:: + - The ec2_elb fact currently set by this module has been deprecated and will no longer be set after release 4.0.0 of the collection. + - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` + - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. + - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. + + + +Examples +-------- + +.. code-block:: yaml + + # Note: None of these examples set aws_access_key, aws_secret_key, or region. + # It is assumed that their matching environment variables are set. + + # Basic provisioning example (non-VPC) + + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + proxy_protocol: True + - protocol: https + load_balancer_port: 443 + instance_protocol: http # optional, defaults to value of protocol setting + instance_port: 80 + # ssl certificate required for https or ssl + ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert" + + # Internal ELB example + + - amazon.aws.elb_classic_lb: + name: "test-vpc" + scheme: internal + state: present + instance_ids: + - i-abcd1234 + purge_instance_ids: true + subnets: + - subnet-abcd1234 + - subnet-1a2b3c4d + listeners: + - protocol: http # options are http, https, ssl, tcp + load_balancer_port: 80 + instance_port: 80 + + # Configure a health check and the access logs + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + health_check: + ping_protocol: http # options are http, https, ssl, tcp + ping_port: 80 + ping_path: "/index.html" # not required for tcp or ssl + response_timeout: 5 # seconds + interval: 30 # seconds + unhealthy_threshold: 2 + healthy_threshold: 10 + access_logs: + interval: 5 # minutes (defaults to 60) + s3_location: "my-bucket" # This value is required if access_logs is set + s3_prefix: "logs" + + # Ensure ELB is gone + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + + # Ensure ELB is gone and wait for check (for default timeout) + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + + # Ensure ELB is gone and wait for check with timeout value + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: absent + wait: yes + wait_timeout: 600 + + # Normally, this module will purge any listeners that exist on the ELB + # but aren't specified in the listeners parameter. If purge_listeners is + # false it leaves them alone + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_listeners: no + + # Normally, this module will leave availability zones that are enabled + # on the ELB alone. If purge_zones is true, then any extraneous zones + # will be removed + - amazon.aws.elb_classic_lb: + name: "test-please-delete" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + purge_zones: yes + + # Creates a ELB and assigns a list of subnets to it. + - amazon.aws.elb_classic_lb: + state: present + name: 'New ELB' + security_group_ids: 'sg-123456, sg-67890' + subnets: 'subnet-123456,subnet-67890' + purge_subnets: yes + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + + # Create an ELB with connection draining, increased idle timeout and cross availability + # zone load balancing + - amazon.aws.elb_classic_lb: + name: "New ELB" + state: present + connection_draining_timeout: 60 + idle_timeout: 300 + cross_az_load_balancing: "yes" + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + + # Create an ELB with load balancer stickiness enabled + - amazon.aws.elb_classic_lb: + name: "New ELB" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: loadbalancer + enabled: yes + expiration: 300 + + # Create an ELB with application stickiness enabled + - amazon.aws.elb_classic_lb: + name: "New ELB" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + stickiness: + type: application + enabled: yes + cookie: SESSIONID + + # Create an ELB and add tags + - amazon.aws.elb_classic_lb: + name: "New ELB" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: + Name: "New ELB" + stack: "production" + client: "Bob" + + # Delete all tags from an ELB + - amazon.aws.elb_classic_lb: + name: "New ELB" + state: present + zones: + - us-east-1a + - us-east-1d + listeners: + - protocol: http + load_balancer_port: 80 + instance_port: 80 + tags: {} + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ elb + +
+ dictionary +
+ 		always +
Load Balancer attributes
+
+
  +
+ app_cookie_policy + +
+ string +
+ 		when state is not 'absent' +
The name of the policy used to control if the ELB is using a application cookie stickiness policy.
+
+
Sample:
+
ec2-elb-lb-AppCookieStickinessPolicyType
+
  +
+ backends + +
+ string +
+ 		when state is not 'absent' +
A description of the backend policy applied to the ELB (instance-port:policy-name).
+
+
Sample:
+
8181:ProxyProtocol-policy
+
  +
+ connection_draining_timeout + +
+ integer +
+ 		when state is not 'absent' +
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
+
+
Sample:
+
25
+
  +
+ cross_az_load_balancing + +
+ string +
+ 		when state is not 'absent' +
Either 'yes' if cross-AZ load balancing is enabled, or 'no' if cross-AZ load balancing is disabled.
+
+
Sample:
+
yes
+
  +
+ dns_name + +
+ string +
+ 		when state is not 'absent' +
The DNS name of the ELB.
+
+
Sample:
+
internal-ansible-test-935c585850ac-1516306744.us-east-1.elb.amazonaws.com
+
  +
+ health_check + +
+ dictionary +
+ 		when state is not 'absent' +
A dictionary describing the health check used for the ELB.
+
+
   +
+ healthy_threshold + +
+ integer +
+ 		+
The number of consecutive successful health checks before marking an instance as healthy.
+
+
Sample:
+
2
+
   +
+ interval + +
+ integer +
+ 		+
The time, in seconds, between each health check.
+
+
Sample:
+
10
+
   +
+ target + +
+ string +
+ 		+
The Protocol, Port, and for HTTP(S) health checks the path tested by the health check.
+
+
Sample:
+
TCP:22
+
   +
+ timeout + +
+ integer +
+ 		+
The time, in seconds, after which an in progress health check is considered failed due to a timeout.
+
+
Sample:
+
5
+
   +
+ unhealthy_threshold + +
+ integer +
+ 		+
The number of consecutive failed health checks before marking an instance as unhealthy.
+
+
Sample:
+
2
+
  +
+ hosted_zone_id + +
+ string +
+ 		when state is not 'absent' +
The ID of the Amazon Route 53 hosted zone for the load balancer.
+
+
Sample:
+
Z35SXDOTRQ7X7K
+
  +
+ hosted_zone_name + +
+ string +
+ 		when state is not 'absent' +
The DNS name of the load balancer when using a custom hostname.
+
+
Sample:
+
ansible-module.example
+
  +
+ idle_timeout + +
+ integer +
+ 		when state is not 'absent' +
The length of of time before an idle connection is dropped by the ELB.
+
+
Sample:
+
50
+
  +
+ in_service_count + +
+ integer +
+ 		when state is not 'absent' +
The number of instances attached to the ELB in an in-service state.
+
+
Sample:
+
1
+
  +
+ instance_health + +
+ list + / elements=dictionary +
+ 		when state is not 'absent' +
A list of dictionaries describing the health of each instance attached to the ELB.
+
+
   +
+ description + +
+ string +
+ 		when state is not 'absent' +
A human readable description of why the instance is not in service.
+
+
Sample:
+
N/A
+
   +
+ instance_id + +
+ string +
+ 		when state is not 'absent' +
The ID of the instance.
+
+
Sample:
+
i-03dcc8953a03d6435
+
   +
+ reason_code + +
+ string +
+ 		when state is not 'absent' +
A code describing why the instance is not in service.
+
+
Sample:
+
N/A
+
   +
+ state + +
+ string +
+ 		when state is not 'absent' +
The current service state of the instance.
+
+
Sample:
+
InService
+
  +
+ instances + +
+ list + / elements=string +
+ 		when state is not 'absent' +
A list of the IDs of instances attached to the ELB.
+
+
Sample:
+
['i-03dcc8953a03d6435']
+
  +
+ lb_cookie_policy + +
+ string +
+ 		when state is not 'absent' +
The name of the policy used to control if the ELB is using a cookie stickiness policy.
+
+
Sample:
+
ec2-elb-lb-LBCookieStickinessPolicyType
+
  +
+ listeners + +
+ list + / elements=list +
+ 		when state is not 'absent' +
A list of lists describing the listeners attached to the ELB.
+
The nested list contains the listener port, the instance port, the listener protoco, the instance port, and where appropriate the ID of the SSL certificate for the port.
+
+
Sample:
+
[[22, 22, 'TCP', 'TCP'], [80, 8181, 'HTTP', 'HTTP']]
+
  +
+ name + +
+ string +
+ 		when state is not 'absent' +
The name of the ELB. This name is unique per-region, per-account.
+
+
Sample:
+
ansible-test-935c585850ac
+
  +
+ out_of_service_count + +
+ integer +
+ 		when state is not 'absent' +
The number of instances attached to the ELB in an out-of-service state.
+
+
  +
+ proxy_policy + +
+ string +
+ 		when the proxy protocol policy exists. +
The name of the policy used to control if the ELB operates using the Proxy protocol.
+
+
Sample:
+
ProxyProtocol-policy
+
  +
+ region + +
+ string +
+ 		always +
The AWS region in which the ELB is running.
+
+
Sample:
+
us-east-1
+
  +
+ scheme + +
+ string +
+ 		when state is not 'absent' +
Whether the ELB is an 'internal' or a 'internet-facing' load balancer.
+
+
Sample:
+
internal
+
  +
+ security_group_ids + +
+ list + / elements=string +
+ 		when state is not 'absent' +
A list of the IDs of the Security Groups attached to the ELB.
+
+
Sample:
+
['sg-0c12ebd82f2fb97dc', 'sg-01ec7378d0c7342e6']
+
  +
+ status + +
+ string +
+ 		always +
A minimal description of the current state of the ELB. Valid values are 'exists', 'gone', 'deleted', 'created'.
+
+
Sample:
+
exists
+
  +
+ subnets + +
+ list + / elements=string +
+ 		when state is not 'absent' +
A list of the subnet IDs attached to the ELB.
+
+
Sample:
+
['subnet-00d9d0f70c7e5f63c', 'subnet-03fa5253586b2d2d5']
+
  +
+ tags + +
+ dictionary +
+ 		when state is not 'absent' +
A dictionary describing the tags attached to the ELB.
+
+
Sample:
+
{'Name': 'ansible-test-935c585850ac', 'ExampleTag': 'Example Value'}
+
  +
+ unknown_instance_state_count + +
+ integer +
+ 		when state is not 'absent' +
The number of instances attached to the ELB in an unknown state.
+
+
  +
+ zones + +
+ list + / elements=string +
+ 		when state is not 'absent' +
A list of the AWS regions in which the ELB is running.
+
+
Sample:
+
['us-east-1b', 'us-east-1a']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Jim Dalton (@jsdalton) +- Mark Chappell (@tremble) diff --git a/galaxy.yml b/galaxy.yml index 56889de5d86..5ff48d4fa30 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: amazon name: aws -version: 2.0.0 +version: 2.1.0 readme: README.md authors: - Ansible (https://github.com/ansible)