From 5630f510c321f007aa07523d4fff13bc1038b4b9 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Tue, 2 Aug 2022 14:31:04 +0200 Subject: [PATCH 1/3] Prepare release 3.4.0 --- CHANGELOG.rst | 19 +++++++++++++++++-- changelogs/changelog.yaml | 17 +++++++++++++++++ ..._application_lb-ForwardConfig-KeyError.yml | 2 -- ...14-elb_classic_lb-security_group_names.yml | 3 --- .../fragments/927-ec2_instance-retries.yml | 2 -- 5 files changed, 34 insertions(+), 9 deletions(-) delete mode 100644 changelogs/fragments/1089-elb_application_lb-ForwardConfig-KeyError.yml delete mode 100644 changelogs/fragments/914-elb_classic_lb-security_group_names.yml delete mode 100644 changelogs/fragments/927-ec2_instance-retries.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ea2b421cca8..22f1d18f512 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,6 @@ -=========================== +======================== amazon.aws Release Notes -=========================== +======================== .. contents:: Topics @@ -85,6 +85,21 @@ Bugfixes - ec2_vpc_net - fix a bug where the module would get stuck if DNS options were updated in check mode (https://github.com/ansible/ansible/issues/62677). - elb_classic_lb - modify the return value of _format_listeners method to resolve a failure creating https listeners (https://github.com/ansible-collections/amazon.aws/pull/860). +v3.4.0 +====== + +Minor Changes +------------- + +- ec2_instance - expanded the use of the automatic retries on temporary failures (https://github.com/ansible-collections/amazon.aws/issues/927). + +Bugfixes +-------- + +- elb_application_lb - fix ``KeyError`` when balancing across two Target Groups (https://github.com/ansible-collections/community.aws/issues/1089). +- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB in check mode with a health check (https://github.com/ansible-collections/amazon.aws/pull/915). +- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB using security group names (https://github.com/ansible-collections/amazon.aws/issues/914). + v3.3.1 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 5d9c9ddec10..28016c3cc0c 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -819,6 +819,23 @@ releases: release_date: '2022-05-26' 3.3.1: release_date: '2022-06-22' + 3.4.0: + changes: + bugfixes: + - elb_application_lb - fix ``KeyError`` when balancing across two Target Groups + (https://github.com/ansible-collections/community.aws/issues/1089). + - elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating + a new ELB in check mode with a health check (https://github.com/ansible-collections/amazon.aws/pull/915). + - elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating + a new ELB using security group names (https://github.com/ansible-collections/amazon.aws/issues/914). + minor_changes: + - ec2_instance - expanded the use of the automatic retries on temporary failures + (https://github.com/ansible-collections/amazon.aws/issues/927). + fragments: + - 1089-elb_application_lb-ForwardConfig-KeyError.yml + - 914-elb_classic_lb-security_group_names.yml + - 927-ec2_instance-retries.yml + release_date: '2022-08-02' 4.0.0: changes: breaking_changes: diff --git a/changelogs/fragments/1089-elb_application_lb-ForwardConfig-KeyError.yml b/changelogs/fragments/1089-elb_application_lb-ForwardConfig-KeyError.yml deleted file mode 100644 index 85fe377e71a..00000000000 --- a/changelogs/fragments/1089-elb_application_lb-ForwardConfig-KeyError.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- elb_application_lb - fix ``KeyError`` when balancing across two Target Groups (https://github.com/ansible-collections/community.aws/issues/1089). diff --git a/changelogs/fragments/914-elb_classic_lb-security_group_names.yml b/changelogs/fragments/914-elb_classic_lb-security_group_names.yml deleted file mode 100644 index cba89ddadb6..00000000000 --- a/changelogs/fragments/914-elb_classic_lb-security_group_names.yml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: -- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB using security group names (https://github.com/ansible-collections/amazon.aws/issues/914). -- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB in check mode with a health check (https://github.com/ansible-collections/amazon.aws/pull/915). diff --git a/changelogs/fragments/927-ec2_instance-retries.yml b/changelogs/fragments/927-ec2_instance-retries.yml deleted file mode 100644 index 36b1c67bf93..00000000000 --- a/changelogs/fragments/927-ec2_instance-retries.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_instance - expanded the use of the automatic retries on temporary failures (https://github.com/ansible-collections/amazon.aws/issues/927). From 37517f1d42d13baff2e2f578f7b093d54dddb684 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Tue, 2 Aug 2022 14:33:59 +0200 Subject: [PATCH 2/3] Prepare release 4.1.0 --- CHANGELOG.rst | 22 ++++++++++++++ changelogs/changelog.yaml | 29 +++++++++++++++++++ .../fragments/862-aws_ec2-hostnames.yml | 2 -- .../fragments/882-s3_bucket-bucket-keys.yml | 2 -- docs/amazon.aws.aws_az_info_module.rst | 1 - docs/amazon.aws.ec2_instance_module.rst | 3 +- docs/amazon.aws.s3_bucket_module.rst | 28 ++++++++++++++++++ 7 files changed, 81 insertions(+), 6 deletions(-) delete mode 100644 changelogs/fragments/862-aws_ec2-hostnames.yml delete mode 100644 changelogs/fragments/882-s3_bucket-bucket-keys.yml diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 22f1d18f512..30e7da8d394 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,28 @@ amazon.aws Release Notes .. contents:: Topics +v4.1.0 +====== + +Minor Changes +------------- + +- ec2_instance - expanded the use of the automatic retries on temporary failures (https://github.com/ansible-collections/amazon.aws/issues/927). +- s3_bucket - updated module to enable support for setting S3 Bucket Keys for SSE-KMS (https://github.com/ansible-collections/amazon.aws/pull/882). + +Deprecated Features +------------------- + +- amazon.aws collection - due to the AWS SDKs announcing the end of support for Python less than 3.7 (https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/) support for Python less than 3.7 by this collection has been deprecated and will be removed in a release after 2023-05-31 (https://github.com/ansible-collections/amazon.aws/pull/935). + +Bugfixes +-------- + +- aws_ec2 - ensure the correct number of hosts are returned when tags as hostnames are used (https://github.com/ansible-collections/amazon.aws/pull/862). +- elb_application_lb - fix ``KeyError`` when balancing across two Target Groups (https://github.com/ansible-collections/community.aws/issues/1089). +- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB in check mode with a health check (https://github.com/ansible-collections/amazon.aws/pull/915). +- elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating a new ELB using security group names (https://github.com/ansible-collections/amazon.aws/issues/914). + v4.0.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 28016c3cc0c..bcfcecabacb 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -980,3 +980,32 @@ releases: - 878-ec2_group.yml - release-4--botocore.yml release_date: '2022-06-22' + 4.1.0: + changes: + bugfixes: + - aws_ec2 - ensure the correct number of hosts are returned when tags as hostnames + are used (https://github.com/ansible-collections/amazon.aws/pull/862). + - elb_application_lb - fix ``KeyError`` when balancing across two Target Groups + (https://github.com/ansible-collections/community.aws/issues/1089). + - elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating + a new ELB in check mode with a health check (https://github.com/ansible-collections/amazon.aws/pull/915). + - elb_classic_lb - fix ``'NoneType' object has no attribute`` bug when creating + a new ELB using security group names (https://github.com/ansible-collections/amazon.aws/issues/914). + deprecated_features: + - amazon.aws collection - due to the AWS SDKs announcing the end of support + for Python less than 3.7 (https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/) + support for Python less than 3.7 by this collection has been deprecated and + will be removed in a release after 2023-05-31 (https://github.com/ansible-collections/amazon.aws/pull/935). + minor_changes: + - ec2_instance - expanded the use of the automatic retries on temporary failures + (https://github.com/ansible-collections/amazon.aws/issues/927). + - s3_bucket - updated module to enable support for setting S3 Bucket Keys for + SSE-KMS (https://github.com/ansible-collections/amazon.aws/pull/882). + fragments: + - 1089-elb_application_lb-ForwardConfig-KeyError.yml + - 862-aws_ec2-hostnames.yml + - 882-s3_bucket-bucket-keys.yml + - 914-elb_classic_lb-security_group_names.yml + - 927-ec2_instance-retries.yml + - python.yml + release_date: '2022-08-02' diff --git a/changelogs/fragments/862-aws_ec2-hostnames.yml b/changelogs/fragments/862-aws_ec2-hostnames.yml deleted file mode 100644 index 5202e488b24..00000000000 --- a/changelogs/fragments/862-aws_ec2-hostnames.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- aws_ec2 - ensure the correct number of hosts are returned when tags as hostnames are used (https://github.com/ansible-collections/amazon.aws/pull/862). diff --git a/changelogs/fragments/882-s3_bucket-bucket-keys.yml b/changelogs/fragments/882-s3_bucket-bucket-keys.yml deleted file mode 100644 index 711399ba555..00000000000 --- a/changelogs/fragments/882-s3_bucket-bucket-keys.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- s3_bucket - updated module to enable support for setting S3 Bucket Keys for SSE-KMS (https://github.com/ansible-collections/amazon.aws/pull/882). diff --git a/docs/amazon.aws.aws_az_info_module.rst b/docs/amazon.aws.aws_az_info_module.rst index 84a26e70952..317cf0388a8 100644 --- a/docs/amazon.aws.aws_az_info_module.rst +++ b/docs/amazon.aws.aws_az_info_module.rst @@ -18,7 +18,6 @@ Version added: 1.0.0 Synopsis -------- - Gather information about availability zones in AWS. -- This module was called :ref:`amazon.aws.aws_az_facts ` before Ansible 2.9. The usage did not change. diff --git a/docs/amazon.aws.ec2_instance_module.rst b/docs/amazon.aws.ec2_instance_module.rst index d82ecb46d33..a72eb452a16 100644 --- a/docs/amazon.aws.ec2_instance_module.rst +++ b/docs/amazon.aws.ec2_instance_module.rst @@ -18,8 +18,9 @@ Version added: 1.0.0 Synopsis -------- - Create and manage AWS EC2 instances. -- Note: This module does not support creating `EC2 Spot instances `_. The :ref:`amazon.aws.ec2 ` module can create and manage spot instances. +- Note: This module does not support creating `EC2 Spot instances `_. +- The :ref:`amazon.aws.ec2_spot_instance ` module can create and manage spot instances. diff --git a/docs/amazon.aws.s3_bucket_module.rst b/docs/amazon.aws.s3_bucket_module.rst index 7fdd95d3055..cdd3f68cfe4 100644 --- a/docs/amazon.aws.s3_bucket_module.rst +++ b/docs/amazon.aws.s3_bucket_module.rst @@ -130,6 +130,28 @@ Parameters

aliases: ec2_secret_key, secret_key
+ + +
+ bucket_key_enabled + +
+ boolean +
+
added in 4.1.0
+ + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enable S3 Bucket Keys for SSE-KMS on new objects.
+
See the AWS documentation for more information https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html.
+
Bucket Key encryption is only supported if encryption=aws:kms.
+ +
@@ -707,6 +729,12 @@ Examples encryption: "aws:kms" encryption_key_id: "arn:aws:kms:us-east-1:1234/5678example" + # Create a bucket with aws:kms encryption, Bucket key + - amazon.aws.s3_bucket: + name: mys3bucket + bucket_key_enabled: true + encryption: "aws:kms" + # Create a bucket with aws:kms encryption, default key - amazon.aws.s3_bucket: name: mys3bucket From 6bdc7e00af673d38e0e64646e6a3314d1e64e5ed Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Tue, 2 Aug 2022 17:44:04 +0200 Subject: [PATCH 3/3] Bump docs --- README.md | 18 ++--- ...mazon.aws.aws_account_attribute_lookup.rst | 4 +- docs/amazon.aws.aws_az_info_module.rst | 4 +- docs/amazon.aws.aws_caller_info_module.rst | 4 +- docs/amazon.aws.aws_ec2_inventory.rst | 4 +- docs/amazon.aws.aws_rds_inventory.rst | 4 +- docs/amazon.aws.aws_secret_lookup.rst | 4 +- docs/amazon.aws.aws_ssm_lookup.rst | 4 +- .../amazon.aws.cloudformation_info_module.rst | 4 +- docs/amazon.aws.cloudformation_module.rst | 4 +- docs/amazon.aws.ec2_ami_info_module.rst | 4 +- docs/amazon.aws.ec2_ami_module.rst | 34 ++++---- docs/amazon.aws.ec2_eni_info_module.rst | 4 +- docs/amazon.aws.ec2_eni_module.rst | 4 +- docs/amazon.aws.ec2_instance_info_module.rst | 4 +- docs/amazon.aws.ec2_instance_module.rst | 79 +++++++++++-------- docs/amazon.aws.ec2_key_module.rst | 15 ++-- ...on.aws.ec2_security_group_info_module.rst} | 35 ++++---- ... amazon.aws.ec2_security_group_module.rst} | 28 +++---- docs/amazon.aws.ec2_snapshot_info_module.rst | 4 +- docs/amazon.aws.ec2_snapshot_module.rst | 4 +- ...azon.aws.ec2_spot_instance_info_module.rst | 4 +- docs/amazon.aws.ec2_spot_instance_module.rst | 4 +- docs/amazon.aws.ec2_tag_info_module.rst | 4 +- docs/amazon.aws.ec2_tag_module.rst | 4 +- docs/amazon.aws.ec2_vol_info_module.rst | 4 +- docs/amazon.aws.ec2_vol_module.rst | 28 ++++--- ...on.aws.ec2_vpc_dhcp_option_info_module.rst | 18 ++--- .../amazon.aws.ec2_vpc_dhcp_option_module.rst | 4 +- ...mazon.aws.ec2_vpc_endpoint_info_module.rst | 4 +- docs/amazon.aws.ec2_vpc_endpoint_module.rst | 34 ++++---- ...s.ec2_vpc_endpoint_service_info_module.rst | 4 +- docs/amazon.aws.ec2_vpc_igw_info_module.rst | 4 +- docs/amazon.aws.ec2_vpc_igw_module.rst | 4 +- ...on.aws.ec2_vpc_nat_gateway_info_module.rst | 4 +- .../amazon.aws.ec2_vpc_nat_gateway_module.rst | 4 +- docs/amazon.aws.ec2_vpc_net_info_module.rst | 4 +- docs/amazon.aws.ec2_vpc_net_module.rst | 13 ++- ...on.aws.ec2_vpc_route_table_info_module.rst | 4 +- .../amazon.aws.ec2_vpc_route_table_module.rst | 16 ++-- .../amazon.aws.ec2_vpc_subnet_info_module.rst | 4 +- docs/amazon.aws.ec2_vpc_subnet_module.rst | 4 +- docs/amazon.aws.elb_classic_lb_module.rst | 4 +- docs/amazon.aws.s3_bucket_module.rst | 6 +- docs/amazon.aws.s3_object_module.rst | 6 +- 45 files changed, 230 insertions(+), 228 deletions(-) rename docs/{amazon.aws.ec2_group_info_module.rst => amazon.aws.ec2_security_group_info_module.rst} (97%) rename docs/{amazon.aws.ec2_group_module.rst => amazon.aws.ec2_security_group_module.rst} (99%) diff --git a/README.md b/README.md index c7e342fc4ab..8c22c8e8fd8 100644 --- a/README.md +++ b/README.md @@ -56,36 +56,36 @@ Name | Description [amazon.aws.aws_caller_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.aws_caller_info_module.rst)|Get information about the user and account being used to make AWS calls [amazon.aws.cloudformation](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.cloudformation_module.rst)|Create or delete an AWS CloudFormation stack [amazon.aws.cloudformation_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.cloudformation_info_module.rst)|Obtain information about an AWS CloudFormation stack -[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](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_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 -[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_instance](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_instance_module.rst)|Create & manage EC2 instances [amazon.aws.ec2_instance_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_instance_info_module.rst)|Gather information about ec2 instances 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_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_security_group](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_security_group_module.rst)|Maintain an EC2 security group +[amazon.aws.ec2_security_group_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_security_group_info_module.rst)|Gather information about EC2 security groups in AWS [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)|Gathers information about EC2 volume snapshots in AWS [amazon.aws.ec2_spot_instance](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_spot_instance_module.rst)|Request, stop, reboot or cancel spot instance [amazon.aws.ec2_spot_instance_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_spot_instance_info_module.rst)|Gather information about ec2 spot instance requests [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 [amazon.aws.ec2_tag_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_tag_info_module.rst)|List tags on ec2 resources -[amazon.aws.ec2_vol](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vol_module.rst)|Create and attach a volume, return volume id and device map +[amazon.aws.ec2_vol](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vol_module.rst)|Create and attach a volume, return volume ID and device map [amazon.aws.ec2_vol_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vol_info_module.rst)|Gather information about ec2 volumes in AWS [amazon.aws.ec2_vpc_dhcp_option](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst)|Manages DHCP Options, and can ensure the DHCP options for the given VPC match what's requested -[amazon.aws.ec2_vpc_dhcp_option_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst)|Gather information about dhcp options sets in AWS -[amazon.aws.ec2_vpc_endpoint](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_endpoint_module.rst)|Create and delete AWS VPC Endpoints. +[amazon.aws.ec2_vpc_dhcp_option_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst)|Gather information about DHCP options sets in AWS +[amazon.aws.ec2_vpc_endpoint](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_endpoint_module.rst)|Create and delete AWS VPC endpoints [amazon.aws.ec2_vpc_endpoint_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst)|Retrieves AWS VPC endpoints details using AWS methods [amazon.aws.ec2_vpc_endpoint_service_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst)|Retrieves AWS VPC endpoint service details [amazon.aws.ec2_vpc_igw](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_igw_module.rst)|Manage an AWS VPC Internet gateway [amazon.aws.ec2_vpc_igw_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_igw_info_module.rst)|Gather information about internet gateways in AWS [amazon.aws.ec2_vpc_nat_gateway](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst)|Manage AWS VPC NAT Gateways [amazon.aws.ec2_vpc_nat_gateway_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst)|Retrieves AWS VPC Managed Nat Gateway details using AWS methods -[amazon.aws.ec2_vpc_net](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_net_module.rst)|Configure AWS virtual private clouds +[amazon.aws.ec2_vpc_net](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_net_module.rst)|Configure AWS Virtual Private Clouds [amazon.aws.ec2_vpc_net_info](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_net_info_module.rst)|Gather information about ec2 VPCs in AWS -[amazon.aws.ec2_vpc_route_table](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_route_table_module.rst)|Manage route tables for AWS virtual private clouds +[amazon.aws.ec2_vpc_route_table](https://github.com/ansible-collections/amazon.aws/blob/main/docs/amazon.aws.ec2_vpc_route_table_module.rst)|Manage route tables for AWS Virtual Private Clouds [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 diff --git a/docs/amazon.aws.aws_account_attribute_lookup.rst b/docs/amazon.aws.aws_account_attribute_lookup.rst index 27dcf44e468..76d5d790659 100644 --- a/docs/amazon.aws.aws_account_attribute_lookup.rst +++ b/docs/amazon.aws.aws_account_attribute_lookup.rst @@ -25,8 +25,8 @@ Requirements The below requirements are needed on the local Ansible controller node that executes this lookup. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_az_info_module.rst b/docs/amazon.aws.aws_az_info_module.rst index 317cf0388a8..f300388e341 100644 --- a/docs/amazon.aws.aws_az_info_module.rst +++ b/docs/amazon.aws.aws_az_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_caller_info_module.rst b/docs/amazon.aws.aws_caller_info_module.rst index da5353db1d3..9477e635b93 100644 --- a/docs/amazon.aws.aws_caller_info_module.rst +++ b/docs/amazon.aws.aws_caller_info_module.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_ec2_inventory.rst b/docs/amazon.aws.aws_ec2_inventory.rst index ed59d6e1b89..3ec1f67d94d 100644 --- a/docs/amazon.aws.aws_ec2_inventory.rst +++ b/docs/amazon.aws.aws_ec2_inventory.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the local Ansible controller node that executes this inventory. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_rds_inventory.rst b/docs/amazon.aws.aws_rds_inventory.rst index 469a2db93c0..41c9e81896a 100644 --- a/docs/amazon.aws.aws_rds_inventory.rst +++ b/docs/amazon.aws.aws_rds_inventory.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the local Ansible controller node that executes this inventory. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_secret_lookup.rst b/docs/amazon.aws.aws_secret_lookup.rst index 7d7a2296ba0..5ad7bed08a0 100644 --- a/docs/amazon.aws.aws_secret_lookup.rst +++ b/docs/amazon.aws.aws_secret_lookup.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the local Ansible controller node that executes this lookup. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.aws_ssm_lookup.rst b/docs/amazon.aws.aws_ssm_lookup.rst index c22bb64962c..6763baf9c6b 100644 --- a/docs/amazon.aws.aws_ssm_lookup.rst +++ b/docs/amazon.aws.aws_ssm_lookup.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the local Ansible controller node that executes this lookup. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.cloudformation_info_module.rst b/docs/amazon.aws.cloudformation_info_module.rst index fb99b2d572c..574aed12d0b 100644 --- a/docs/amazon.aws.cloudformation_info_module.rst +++ b/docs/amazon.aws.cloudformation_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.cloudformation_module.rst b/docs/amazon.aws.cloudformation_module.rst index cbd978188d0..19f42d5081b 100644 --- a/docs/amazon.aws.cloudformation_module.rst +++ b/docs/amazon.aws.cloudformation_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_ami_info_module.rst b/docs/amazon.aws.ec2_ami_info_module.rst index e6d3045b4a6..df0eb4d1025 100644 --- a/docs/amazon.aws.ec2_ami_info_module.rst +++ b/docs/amazon.aws.ec2_ami_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_ami_module.rst b/docs/amazon.aws.ec2_ami_module.rst index e91aedae367..d876b697a10 100644 --- a/docs/amazon.aws.ec2_ami_module.rst +++ b/docs/amazon.aws.ec2_ami_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_ami ****************** -**Create or destroy an image (AMI) in ec2** +**Create or destroy an image (AMI) in EC2** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Registers or deregisters ec2 images. +- Registers or deregisters EC2 images. @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -54,7 +54,7 @@ Parameters Default:
"x86_64"
-
The target architecture of the image to register
+
The target architecture of the image to register.
@@ -136,7 +136,7 @@ Parameters -
A list of valid billing codes. To be used with valid accounts by aws marketplace vendors.
+
A list of valid billing codes. To be used with valid accounts by AWS Marketplace vendors.
@@ -243,8 +243,6 @@ Parameters
The device name. For example /dev/sda.
-
The DeviceName alias had been deprecated and will be removed in release 5.0.0.
-

aliases: DeviceName
@@ -280,7 +278,7 @@ Parameters -
When using an io1 volume_type this sets the number of IOPS provisioned for the volume
+
When using an io1 volume_type this sets the number of IOPS provisioned for the volume.
@@ -301,8 +299,6 @@ Parameters
Suppresses the specified device included in the block device mapping of the AMI.
-
The NoDevice alias has been deprecated and will be removed in release 5.0.0.
-

aliases: NoDevice
@@ -336,8 +332,6 @@ Parameters
The virtual name for the device.
-
The VirtualName alias has been deprecated and will be removed in release 5.0.0.
-

aliases: VirtualName
@@ -353,7 +347,7 @@ Parameters -
The size of the volume (in GiB)
+
The size of the volume (in GiB).

aliases: size
@@ -436,7 +430,7 @@ Parameters -
The s3 location of an image to use for the AMI.
+
The S3 location of an image to use for the AMI.
@@ -481,8 +475,11 @@ Parameters -
Users and groups that should be able to launch the AMI. Expects dictionary with a key of user_ids and/or group_names. user_ids should be a list of account ids. group_name should be a list of groups, "all" is the only acceptable value currently.
-
You must pass all desired launch permissions if you wish to modify existing launch permissions (passing just groups will remove all users)
+
Users and groups that should be able to launch the AMI.
+
Expects dictionary with a key of user_ids and/or group_names.
+
user_ids should be a list of account IDs.
+
group_name should be a list of groups, all is the only acceptable value currently.
+
You must pass all desired launch permissions if you wish to modify existing launch permissions (passing just groups will remove all users).
@@ -547,14 +544,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
diff --git a/docs/amazon.aws.ec2_eni_info_module.rst b/docs/amazon.aws.ec2_eni_info_module.rst index 85062c6f629..9322401a22b 100644 --- a/docs/amazon.aws.ec2_eni_info_module.rst +++ b/docs/amazon.aws.ec2_eni_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_eni_module.rst b/docs/amazon.aws.ec2_eni_module.rst index 0af67195512..c53485d8202 100644 --- a/docs/amazon.aws.ec2_eni_module.rst +++ b/docs/amazon.aws.ec2_eni_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_instance_info_module.rst b/docs/amazon.aws.ec2_instance_info_module.rst index 47ef4ddb43b..9333cdc391b 100644 --- a/docs/amazon.aws.ec2_instance_info_module.rst +++ b/docs/amazon.aws.ec2_instance_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_instance_module.rst b/docs/amazon.aws.ec2_instance_module.rst index a72eb452a16..7ab18bcf5b6 100644 --- a/docs/amazon.aws.ec2_instance_module.rst +++ b/docs/amazon.aws.ec2_instance_module.rst @@ -18,8 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Create and manage AWS EC2 instances. -- Note: This module does not support creating `EC2 Spot instances `_. - +- This module does not support creating `EC2 Spot instances `_. - The :ref:`amazon.aws.ec2_spot_instance ` module can create and manage spot instances. @@ -29,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -161,7 +160,7 @@ Parameters
For T series instances, choose whether to allow increased charges to buy CPU credits if the default pool is depleted.
-
Choose unlimited to enable buying additional CPU credits.
+
Choose unlimited to enable buying additional CPU credits.
@@ -255,7 +254,7 @@ Parameters -
Whether to allow detailed cloudwatch metrics to be collected, enabling more detailed alerting.
+
Whether to allow detailed CloudWatch metrics to be collected, enabling more detailed alerting.
@@ -456,7 +455,9 @@ Parameters -
The ARN or name of an EC2-enabled instance role to be used. If a name is not provided in arn format then the ListInstanceProfiles permission must also be granted. https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListInstanceProfiles.html If no full ARN is provided, the role with a matching name will be used from the active AWS account.
+
The ARN or name of an EC2-enabled instance role to be used.
+
If a name is not provided in ARN format then the ListInstanceProfiles permission must also be granted. https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListInstanceProfiles.html
+
If no full ARN is provided, the role with a matching name will be used from the active AWS account.
@@ -471,8 +472,10 @@ Parameters -
Instance type to use for the instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html Only required when instance is not already present.
-
If not specified, t2.micro will be used.
+ +
Only required when instance is not already present.
+
If not specified, t2.micro will be used.
+
In a release after 2023-01-01 the default will be removed and either instance_type or launch_template must be specificed when launching an instance.
@@ -488,6 +491,7 @@ Parameters
Name of the SSH access key to assign to the instance - must exist in the region the instance is created.
+
Use amazon.aws.ec2_key to manage SSH keys.
@@ -518,7 +522,7 @@ Parameters -
the ID of the launch template (optional if name is specified).
+
The ID of the launch template (optional if name is specified).
@@ -534,7 +538,7 @@ Parameters -
the pretty name of the launch template (optional if id is specified).
+
The pretty name of the launch template (optional if id is specified).
@@ -550,7 +554,7 @@ Parameters -
the specific version of the launch template to use. If unspecified, the template default is chosen.
+
The specific version of the launch template to use. If unspecified, the template default is chosen.
@@ -611,7 +615,8 @@ Parameters -
- Wether the instance metadata endpoint is available via IPv6 (enabled) or not (disabled). - Requires botocore >= 1.21.29
+
Wether the instance metadata endpoint is available via IPv6 (enabled) or not (disabled).
+
Requires botocore >= 1.21.29
@@ -629,7 +634,8 @@ Parameters Default:
1
-
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+
The desired HTTP PUT response hop limit for instance metadata requests.
+
The larger the number, the further instance metadata requests can travel.
@@ -704,7 +710,7 @@ Parameters -
Either a dictionary containing the key 'interfaces' corresponding to a list of network interface IDs or containing specifications for a single network interface.
+
Either a dictionary containing the key interfaces corresponding to a list of network interface IDs or containing specifications for a single network interface.
Use the amazon.aws.ec2_eni module to create ENIs with special settings.
@@ -725,7 +731,7 @@ Parameters -
when true assigns a public IP address to the interface
+
When true assigns a public IP address to the interface.
@@ -761,7 +767,7 @@ Parameters -
a description for the network interface
+
A description for the network interface.
@@ -777,7 +783,7 @@ Parameters -
The index of the interface to modify
+
The index of the interface to modify.
@@ -794,7 +800,7 @@ Parameters -
a list of security group IDs to attach to the interface
+
A list of security group IDs to attach to the interface.
@@ -811,7 +817,7 @@ Parameters -
a list of ENI IDs (strings) or a list of objects containing the key id.
+
A list of ENI IDs (strings) or a list of objects containing the key id.
@@ -828,7 +834,7 @@ Parameters -
a list of IPv6 addresses to assign to the network interface
+
A list of IPv6 addresses to assign to the network interface.
@@ -844,7 +850,7 @@ Parameters -
an IPv4 address to assign to the interface
+
An IPv4 address to assign to the interface.
@@ -861,7 +867,7 @@ Parameters -
a list of IPv4 addresses to assign to the network interface
+
A list of IPv4 addresses to assign to the network interface.
@@ -881,7 +887,7 @@ Parameters -
controls whether source/destination checking is enabled on the interface
+
Controls whether source/destination checking is enabled on the interface.
@@ -897,7 +903,7 @@ Parameters -
the subnet to connect the network interface to
+
The subnet to connect the network interface to.
@@ -913,7 +919,7 @@ Parameters -
The placement group that needs to be assigned to the instance
+
The placement group that needs to be assigned to the instance.
@@ -944,14 +950,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
@@ -982,7 +987,8 @@ Parameters -
A security group ID or name. Mutually exclusive with security_groups.
+
A security group ID or name.
+
Mutually exclusive with security_groups.
@@ -998,7 +1004,8 @@ Parameters -
A list of security group IDs or names (strings). Mutually exclusive with security_group.
+
A list of security group IDs or names (strings).
+
Mutually exclusive with security_group.
@@ -1104,7 +1111,8 @@ Parameters -
Whether to enable termination protection. This module will not terminate an instance with termination protection active, it must be turned off first.
+
Whether to enable termination protection.
+
This module will not terminate an instance with termination protection active, it must be turned off first.
@@ -1186,7 +1194,7 @@ Parameters -
Opaque blob of data which is made available to the ec2 instance
+
Opaque blob of data which is made available to the EC2 instance.
@@ -1222,7 +1230,7 @@ Parameters
A list of block device mappings, by default this will always use the AMI root device so the volumes option is primarily for adding more storage.
-
A mapping contains the (optional) keys device_name, virtual_name, ebs.volume_type, ebs.volume_size, ebs.kms_key_id, ebs.snapshot_id, ebs.iops, and ebs.delete_on_termination.
+
A mapping contains the (optional) keys device_name, virtual_name, ebs.volume_type, ebs.volume_size, ebs.kms_key_id, ebs.snapshot_id, ebs.iops, and ebs.delete_on_termination.
@@ -1238,7 +1246,8 @@ Parameters -
The subnet ID in which to launch the instance (VPC) If none is provided, amazon.aws.ec2_instance will chose the default zone of the default VPC.
+
The subnet ID in which to launch the instance (VPC).
+
If none is provided, amazon.aws.ec2_instance will chose the default zone of the default VPC.

aliases: subnet_id
@@ -1258,7 +1267,7 @@ Parameters -
Whether or not to wait for the desired state (use wait_timeout to customize this).
+
Whether or not to wait for the desired state (use (wait_timeout) to customize this).
diff --git a/docs/amazon.aws.ec2_key_module.rst b/docs/amazon.aws.ec2_key_module.rst index 05ed904fc04..24f962c8bd8 100644 --- a/docs/amazon.aws.ec2_key_module.rst +++ b/docs/amazon.aws.ec2_key_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_key ****************** -**Create or delete an ec2 key pair** +**Create or delete an EC2 key pair** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- create or delete an ec2 key pair. +- Create or delete an EC2 key pair. @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -244,14 +244,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
@@ -304,7 +303,7 @@ Parameters -
create or delete keypair
+
Create or delete keypair.
@@ -365,7 +364,7 @@ Examples # Note: These examples do not set authentication details, see the AWS Guide for details. - - name: create a new ec2 key pair, returns generated private key + - name: create a new EC2 key pair, returns generated private key amazon.aws.ec2_key: name: my_keypair diff --git a/docs/amazon.aws.ec2_group_info_module.rst b/docs/amazon.aws.ec2_security_group_info_module.rst similarity index 97% rename from docs/amazon.aws.ec2_group_info_module.rst rename to docs/amazon.aws.ec2_security_group_info_module.rst index ef20b25e883..d6f60582da4 100644 --- a/docs/amazon.aws.ec2_group_info_module.rst +++ b/docs/amazon.aws.ec2_security_group_info_module.rst @@ -1,11 +1,11 @@ -.. _amazon.aws.ec2_group_info_module: +.. _amazon.aws.ec2_security_group_info_module: -************************* -amazon.aws.ec2_group_info -************************* +********************************** +amazon.aws.ec2_security_group_info +********************************** -**Gather information about ec2 security groups in AWS** +**Gather information about EC2 security groups in AWS** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Gather information about ec2 security groups in AWS. +- Gather information about EC2 security groups in AWS. @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -235,7 +235,8 @@ Notes ----- .. note:: - - By default, the module will return all security groups. To limit results use the appropriate filters. + - By default, the module will return all security groups in a region. To limit results use the appropriate filters. + - Prior to release 5.0.0 this module was called ``amazon.aws.ec2_group_info``. The usage did not change. - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -250,36 +251,36 @@ Examples # Note: These examples do not set authentication details, see the AWS Guide for details. # Gather information about all security groups - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: # Gather information about all security groups in a specific VPC - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: vpc-id: vpc-12345678 # Gather information about all security groups in a specific VPC - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: vpc-id: vpc-12345678 # Gather information about a security group - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: group-name: example-1 # Gather information about a security group by id - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: group-id: sg-12345678 # Gather information about a security group with multiple filters, also mixing the use of underscores as filter keys - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: group_id: sg-12345678 vpc-id: vpc-12345678 # Gather information about various security groups - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: group-name: - example-1 @@ -288,7 +289,7 @@ Examples # Gather information about any security group with a tag key Name and value Example. # The quotes around 'tag:name' are important because of the colon in the value - - amazon.aws.ec2_group_info: + - amazon.aws.ec2_security_group_info: filters: "tag:Name": Example diff --git a/docs/amazon.aws.ec2_group_module.rst b/docs/amazon.aws.ec2_security_group_module.rst similarity index 99% rename from docs/amazon.aws.ec2_group_module.rst rename to docs/amazon.aws.ec2_security_group_module.rst index f70b01c026a..ce9ca8dac86 100644 --- a/docs/amazon.aws.ec2_group_module.rst +++ b/docs/amazon.aws.ec2_security_group_module.rst @@ -1,11 +1,11 @@ -.. _amazon.aws.ec2_group_module: +.. _amazon.aws.ec2_security_group_module: -******************** -amazon.aws.ec2_group -******************** +***************************** +amazon.aws.ec2_security_group +***************************** -**Maintain an ec2 VPC security group** +**Maintain an EC2 security group** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Maintains ec2 security groups. +- Maintains EC2 security groups. @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -839,7 +839,7 @@ Notes .. note:: - If a rule declares a group_name and that group doesn't exist, it will be automatically created. In that case, group_desc should be provided as well. The module will refuse to create a depended-on group without a description. - - Preview diff mode support is added in version 2.7. + - Prior to release 5.0.0 this module was called ``amazon.aws.ec2_group_info``. The usage did not change. - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files. @@ -852,7 +852,7 @@ Examples .. code-block:: yaml - name: example using security group rule descriptions - amazon.aws.ec2_group: + amazon.aws.ec2_security_group: name: "{{ name }}" description: sg with rule descriptions vpc_id: vpc-xxxxxxxx @@ -866,7 +866,7 @@ Examples rule_desc: allow all on port 80 - name: example using ICMP types and codes - amazon.aws.ec2_group: + amazon.aws.ec2_security_group: name: "{{ name }}" description: sg for ICMP vpc_id: vpc-xxxxxxxx @@ -879,7 +879,7 @@ Examples cidr_ip: 0.0.0.0/0 - name: example ec2 group - amazon.aws.ec2_group: + amazon.aws.ec2_security_group: name: example description: an example EC2 group vpc_id: 12345 @@ -939,7 +939,7 @@ Examples group_desc: other example EC2 group - name: example2 ec2 group - amazon.aws.ec2_group: + amazon.aws.ec2_security_group: name: example2 description: an example2 EC2 group vpc_id: 12345 @@ -979,7 +979,7 @@ Examples diff: True - name: "Delete group by its id" - amazon.aws.ec2_group: + amazon.aws.ec2_security_group: region: eu-west-1 group_id: sg-33b4ee5b state: absent diff --git a/docs/amazon.aws.ec2_snapshot_info_module.rst b/docs/amazon.aws.ec2_snapshot_info_module.rst index ccdce99b1b7..55bc6160b02 100644 --- a/docs/amazon.aws.ec2_snapshot_info_module.rst +++ b/docs/amazon.aws.ec2_snapshot_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_snapshot_module.rst b/docs/amazon.aws.ec2_snapshot_module.rst index db618f79b3d..1c4e4c006c9 100644 --- a/docs/amazon.aws.ec2_snapshot_module.rst +++ b/docs/amazon.aws.ec2_snapshot_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_spot_instance_info_module.rst b/docs/amazon.aws.ec2_spot_instance_info_module.rst index 4d0419cc1ae..74cebc06e32 100644 --- a/docs/amazon.aws.ec2_spot_instance_info_module.rst +++ b/docs/amazon.aws.ec2_spot_instance_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_spot_instance_module.rst b/docs/amazon.aws.ec2_spot_instance_module.rst index d679a70598f..e7959d410ca 100644 --- a/docs/amazon.aws.ec2_spot_instance_module.rst +++ b/docs/amazon.aws.ec2_spot_instance_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_tag_info_module.rst b/docs/amazon.aws.ec2_tag_info_module.rst index 1c442b461c5..e607e03e122 100644 --- a/docs/amazon.aws.ec2_tag_info_module.rst +++ b/docs/amazon.aws.ec2_tag_info_module.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_tag_module.rst b/docs/amazon.aws.ec2_tag_module.rst index 04bb26f50d3..6122783a0ed 100644 --- a/docs/amazon.aws.ec2_tag_module.rst +++ b/docs/amazon.aws.ec2_tag_module.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vol_info_module.rst b/docs/amazon.aws.ec2_vol_info_module.rst index 405dee93833..d1a2461a6e4 100644 --- a/docs/amazon.aws.ec2_vol_info_module.rst +++ b/docs/amazon.aws.ec2_vol_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst index bb0a1c37a8f..5233c9513e3 100644 --- a/docs/amazon.aws.ec2_vol_module.rst +++ b/docs/amazon.aws.ec2_vol_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_vol ****************** -**Create and attach a volume, return volume id and device map** +**Create and attach a volume, return volume ID and device map** Version added: 1.0.0 @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -158,7 +158,7 @@ Parameters -
Device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows.
+
Device ID to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows.
@@ -208,7 +208,7 @@ Parameters -
Volume id if you wish to attach an existing volume (requires instance) or remove an existing volume
+
Volume ID if you wish to attach an existing volume (requires instance) or remove an existing volume.
@@ -223,7 +223,8 @@ Parameters -
Instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.
+
Instance ID if you wish to attach the volume.
+
Set to None to detach the volume.
@@ -253,7 +254,7 @@ Parameters -
Specify the id of the KMS key to use.
+
Specify the ID of the KMS key to use.
@@ -293,7 +294,7 @@ Parameters -
If set to yes, Multi-Attach will be enabled when creating the volume.
+
If set to true, Multi-Attach will be enabled when creating the volume.
When you create a new volume, Multi-Attach is disabled by default.
This parameter is supported with io1 and io2 volumes only.
@@ -310,7 +311,7 @@ Parameters -
Volume Name tag if you wish to attach an existing volume (requires instance)
+
Volume Name tag if you wish to attach an existing volume (requires instance).
@@ -358,14 +359,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
@@ -434,7 +434,8 @@ Parameters
Whether to ensure the volume is present or absent.
-
state=list was deprecated in release 1.1.0 and is no longer available with release 4.0.0. The 'list' functionality has been moved to a dedicated module amazon.aws.ec2_vol_info.
+
state=list was deprecated in release 1.1.0 and is no longer available with release 4.0.0.
+
The list functionality has been moved to a dedicated module amazon.aws.ec2_vol_info.
@@ -527,7 +528,8 @@ Parameters -
Type of EBS volume; standard (magnetic), gp2 (SSD), gp3 (SSD), io1 (Provisioned IOPS), io2 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). "Standard" is the old EBS default and continues to remain the Ansible default for backwards compatibility.
+
Type of EBS volume; standard (magnetic), gp2 (SSD), gp3 (SSD), io1 (Provisioned IOPS), io2 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD).
+
standard is the old EBS default and continues to remain the Ansible default for backwards compatibility.
diff --git a/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst b/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst index 2018669dcd3..0c74b87ed8e 100644 --- a/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_vpc_dhcp_option_info *********************************** -**Gather information about dhcp options sets in AWS** +**Gather information about DHCP options sets in AWS** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Gather information about dhcp options sets in AWS. +- Gather information about DHCP options sets in AWS. @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -139,9 +139,7 @@ Parameters -
Get details of specific DHCP Option IDs.
-
The DhcpOptionIds alias has been deprecated and will be removed in release 5.0.0.
-

aliases: DhcpOptionIds
+
Get details of specific DHCP option IDs.
@@ -160,9 +158,7 @@ Parameters -
Checks whether you have the required permissions to view the DHCP Options.
-
The DryRun alias has been deprecated and will be removed in release 5.0.0.
-

aliases: DryRun
+
Checks whether you have the required permissions to view the DHCP options.
@@ -304,7 +300,7 @@ Examples amazon.aws.ec2_vpc_dhcp_option_info: region: ap-southeast-2 profile: production - DhcpOptionsIds: dopt-123fece2 + dhcp_options_ids: dopt-123fece2 register: dhcp_info diff --git a/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst b/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst index 52c67a4d1fd..60c00531e1a 100644 --- a/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst +++ b/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst index fc8fc0d43c8..77b71d1b001 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_endpoint_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_module.rst index 24f6d72b611..b61c03fc379 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_vpc_endpoint *************************** -**Create and delete AWS VPC Endpoints.** +**Create and delete AWS VPC endpoints** Version added: 1.0.0 @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -121,7 +121,7 @@ Parameters -
Optional client token to ensure idempotency
+
Optional client token to ensure idempotency.
@@ -171,7 +171,7 @@ Parameters -
A properly formatted json policy as string, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Cannot be used with policy_file.
+
A properly formatted JSON policy as string, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Cannot be used with policy_file.
Option when creating an endpoint. If not provided AWS will utilise a default policy which provides full access to the service.
@@ -221,14 +221,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
@@ -260,8 +259,9 @@ Parameters -
List of one or more route table ids to attach to the endpoint. A route is added to the route table with the destination of the endpoint if provided.
-
Route table ids are only valid for gateway type endpoints.
+
List of one or more route table IDs to attach to the endpoint.
+
A route is added to the route table with the destination of the endpoint if provided.
+
Route table IDs are only valid for Gateway endpoints.
@@ -294,7 +294,7 @@ Parameters -
An AWS supported vpc endpoint service. Use the amazon.aws.ec2_vpc_endpoint_info module to describe the supported endpoint services.
+
An AWS supported VPC endpoint service. Use the amazon.aws.ec2_vpc_endpoint_info module to describe the supported endpoint services.
Required when creating an endpoint.
@@ -314,8 +314,8 @@ Parameters -
present to ensure resource is created.
-
absent to remove resource
+
present to ensure resource is created.
+
absent to remove resource.
@@ -366,7 +366,8 @@ Parameters -
One or more vpc endpoint ids to remove from the AWS account
+
One or more VPC endpoint IDs to remove from the AWS account.
+
Required if state=absent.
@@ -457,7 +458,8 @@ Parameters -
When specified, will wait for either available status for state present. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
+
When specified, will wait for status to reach available for state=present.
+
Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
@@ -473,7 +475,9 @@ Parameters Default:
320
-
Used in conjunction with wait. Number of seconds to wait for status. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
+
Used in conjunction with wait.
+
Number of seconds to wait for status.
+
Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
diff --git a/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst index 532034cc374..edd60d95a8f 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_igw_info_module.rst b/docs/amazon.aws.ec2_vpc_igw_info_module.rst index e78ad730bfa..2f85924a46d 100644 --- a/docs/amazon.aws.ec2_vpc_igw_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_igw_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_igw_module.rst b/docs/amazon.aws.ec2_vpc_igw_module.rst index 0614addbdcf..91e05570421 100644 --- a/docs/amazon.aws.ec2_vpc_igw_module.rst +++ b/docs/amazon.aws.ec2_vpc_igw_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst b/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst index 6de10c0d96f..0d58b4d2ae7 100644 --- a/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst index e894ebbd541..f3d04b32076 100644 --- a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst +++ b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_net_info_module.rst b/docs/amazon.aws.ec2_vpc_net_info_module.rst index 6f009d36d79..e5f0aeaac07 100644 --- a/docs/amazon.aws.ec2_vpc_net_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_net_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_net_module.rst b/docs/amazon.aws.ec2_vpc_net_module.rst index 0b73196beea..46b862e9d45 100644 --- a/docs/amazon.aws.ec2_vpc_net_module.rst +++ b/docs/amazon.aws.ec2_vpc_net_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_vpc_net ********************** -**Configure AWS virtual private clouds** +**Configure AWS Virtual Private Clouds** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Create, modify, and terminate AWS virtual private clouds. +- Create, modify, and terminate AWS Virtual Private Clouds (VPCs). @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -251,7 +251,7 @@ Parameters -
By default the module will not create another VPC if there is another VPC with the same name and CIDR block. Specify this as true if you want duplicate VPCs created.
+
By default the module will not create another VPC if there is another VPC with the same name and CIDR block. Specify multi_ok=true if you want duplicate VPCs created.
@@ -319,14 +319,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
diff --git a/docs/amazon.aws.ec2_vpc_route_table_info_module.rst b/docs/amazon.aws.ec2_vpc_route_table_info_module.rst index d9a9e4e1fc5..98a70c2e46d 100644 --- a/docs/amazon.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_route_table_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_route_table_module.rst b/docs/amazon.aws.ec2_vpc_route_table_module.rst index 3cce5b44288..001e8326a7a 100644 --- a/docs/amazon.aws.ec2_vpc_route_table_module.rst +++ b/docs/amazon.aws.ec2_vpc_route_table_module.rst @@ -5,7 +5,7 @@ amazon.aws.ec2_vpc_route_table ****************************** -**Manage route tables for AWS virtual private clouds** +**Manage route tables for AWS Virtual Private Clouds** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Manage route tables for AWS virtual private clouds +- Manage route tables for AWS Virtual Private Clouds (VPCs). @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -249,7 +249,8 @@ Parameters -
Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.
+
Purge existing subnets that are not found in subnets.
+
Ignored unless the subnets option is supplied.
@@ -264,14 +265,13 @@ Parameters
    Choices:
  • no
    • -
  • yes
    • +
  • yes ←
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
-
The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
@@ -471,7 +471,7 @@ Examples gateway_id: "{{ igw.gateway_id }}" register: public_route_table - - name: Create vpc gateway + - name: Create VPC gateway amazon.aws.ec2_vpc_igw: vpc_id: vpc-1245678 register: vpc_igw diff --git a/docs/amazon.aws.ec2_vpc_subnet_info_module.rst b/docs/amazon.aws.ec2_vpc_subnet_info_module.rst index 242deddc2b2..4afdce4a5dc 100644 --- a/docs/amazon.aws.ec2_vpc_subnet_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_subnet_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_subnet_module.rst b/docs/amazon.aws.ec2_vpc_subnet_module.rst index 7f2eb7cf5f7..367b90efab7 100644 --- a/docs/amazon.aws.ec2_vpc_subnet_module.rst +++ b/docs/amazon.aws.ec2_vpc_subnet_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.elb_classic_lb_module.rst b/docs/amazon.aws.elb_classic_lb_module.rst index c47c3c3026f..539ab93f524 100644 --- a/docs/amazon.aws.elb_classic_lb_module.rst +++ b/docs/amazon.aws.elb_classic_lb_module.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters diff --git a/docs/amazon.aws.s3_bucket_module.rst b/docs/amazon.aws.s3_bucket_module.rst index cdd3f68cfe4..88535b5c161 100644 --- a/docs/amazon.aws.s3_bucket_module.rst +++ b/docs/amazon.aws.s3_bucket_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -544,8 +544,6 @@ Parameters
S3 URL endpoint for usage with DigitalOcean, Ceph, Eucalyptus and FakeS3 etc.
Assumes AWS if not specified.
For Walrus, use FQDN of the endpoint without scheme nor path.
-
The S3_URL alias for this option has been deprecated and will be removed in release 5.0.0.
-

aliases: S3_URL
diff --git a/docs/amazon.aws.s3_object_module.rst b/docs/amazon.aws.s3_object_module.rst index 5caced54bb7..0082f9f7f8d 100644 --- a/docs/amazon.aws.s3_object_module.rst +++ b/docs/amazon.aws.s3_object_module.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.17.0 -- botocore >= 1.20.0 +- boto3 >= 1.18.0 +- botocore >= 1.21.0 Parameters @@ -669,8 +669,6 @@ Parameters
S3 URL endpoint for usage with Ceph, Eucalyptus and fakes3 etc. Otherwise assumes AWS.
-
The S3_URL alias for this option has been deprecated and will be removed in release 5.0.0.
-

aliases: S3_URL