| When an ENI is associated with an EIP |
- Info of associated elastic IP (EIP)
+ Info of associated elastic IP (EIP).
Sample:
{'allocation_id': 'eipalloc-5sdf123', 'association_id': 'eipassoc-8sdf123', 'ip_owner_id': '4415120123456', 'public_dns_name': 'ec2-52-1-0-63.compute-1.amazonaws.com', 'public_ip': '52.1.0.63'}
@@ -339,7 +332,7 @@ Common return values are documented `here
When an ENI is attached to an ec2 instance |
- Info about attached ec2 instance
+ Info about attached ec2 instance.
Sample:
{'attach_time': '2017-08-05T15:25:47+00:00', 'attachment_id': 'eni-attach-149d21234', 'delete_on_termination': False, 'device_index': 1, 'instance_id': 'i-15b8d3cadbafa1234', 'instance_owner_id': '4415120123456', 'status': 'attached'}
@@ -357,7 +350,7 @@ Common return values are documented `here
always |
- Availability zone of ENI
+ Availability zone of ENI.
Sample:
us-east-1b
@@ -375,7 +368,7 @@ Common return values are documented `here
always |
- Description text for ENI
+ Description text for ENI.
Sample:
My favourite network interface
@@ -393,7 +386,7 @@ Common return values are documented `here
always |
- List of attached security groups
+ List of attached security groups.
Sample:
[{'group_id': 'sg-26d0f1234', 'group_name': 'my_ec2_security_group'}]
@@ -411,7 +404,7 @@ Common return values are documented `here
always |
- The id of the ENI (alias for network_interface_id)
+ The id of the ENI (alias for network_interface_id).
Sample:
eni-392fsdf
@@ -429,7 +422,7 @@ Common return values are documented `here
always |
- Type of the network interface
+ Type of the network interface.
Sample:
interface
@@ -447,7 +440,7 @@ Common return values are documented `here
always |
- List of IPv6 addresses for this interface
+ List of IPv6 addresses for this interface.
|
@@ -463,7 +456,7 @@ Common return values are documented `here
always |
- MAC address of the network interface
+ MAC address of the network interface.
Sample:
0a:f8:10:2f:ab:a1
@@ -482,7 +475,7 @@ Common return values are documented `here
When a Name tag has been set |
- The Name tag of the ENI, often displayed in the AWS UIs as Name
+ The Name tag of the ENI, often displayed in the AWS UIs as Name.
|
@@ -498,7 +491,7 @@ Common return values are documented `here
always |
- The id of the ENI
+ The id of the ENI.
Sample:
eni-392fsdf
@@ -516,7 +509,7 @@ Common return values are documented `here
always |
- AWS account id of the owner of the ENI
+ AWS account id of the owner of the ENI.
Sample:
4415120123456
@@ -534,7 +527,7 @@ Common return values are documented `here
always |
- Private DNS name for the ENI
+ Private DNS name for the ENI.
Sample:
ip-172-16-1-180.ec2.internal
@@ -552,7 +545,7 @@ Common return values are documented `here
always |
- Private IP address for the ENI
+ Private IP address for the ENI.
Sample:
172.16.1.180
@@ -570,7 +563,7 @@ Common return values are documented `here
always |
- List of private IP addresses attached to the ENI
+ List of private IP addresses attached to the ENI.
|
@@ -586,7 +579,7 @@ Common return values are documented `here
always |
- The ID of the entity that launched the ENI
+ The ID of the entity that launched the ENI.
Sample:
AIDAIONYVJQNIAZFT3ABC
@@ -636,7 +629,7 @@ Common return values are documented `here
always |
- Indicates if the network interface is attached to an instance or not
+ Indicates if the network interface is attached to an instance or not.
Sample:
in-use
@@ -654,7 +647,7 @@ Common return values are documented `here
always |
- Subnet ID the ENI is in
+ Subnet ID the ENI is in.
Sample:
subnet-7bbf01234
@@ -672,7 +665,7 @@ Common return values are documented `here
always |
- Dictionary of tags added to the ENI
+ Dictionary of tags added to the ENI.
|
@@ -689,7 +682,7 @@ Common return values are documented `here
always |
- Dictionary of tags added to the ENI
+ Dictionary of tags added to the ENI.
|
@@ -705,7 +698,7 @@ Common return values are documented `here
always |
- ID of the VPC the network interface it part of
+ ID of the VPC the network interface it part of.
Sample:
vpc-b3f1f123
diff --git a/docs/amazon.aws.ec2_eni_module.rst b/docs/amazon.aws.ec2_eni_module.rst
index bbddfc98bc6..0af67195512 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -92,8 +92,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -110,7 +109,6 @@ Parameters
|
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.
|
@@ -128,7 +126,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -144,8 +141,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -297,9 +293,9 @@ Parameters
|
- Name for the ENI. This will create a tag called "Name" with the value assigned here.
+ Name for the ENI. This will create a tag with the key Name and the value assigned here.
This can be used in conjunction with subnet_id as another means of identifiying a network interface.
- AWS does not enforce unique Name tags, so duplicate names are possible if you configure it that way. If that is the case, you will need to provide other identifying information such as private_ip_address or eni_id.
+ AWS does not enforce unique Name tags, so duplicate names are possible if you configure it that way. If that is the case, you will need to provide other identifying information such as private_ip_address or eni_id.
|
@@ -329,8 +325,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -362,7 +357,6 @@ Parameters
boolean
- added in 1.3.0
|
Choices:
@@ -371,8 +365,9 @@ Parameters
|
- Indicates whether to remove tags not specified in tags or name. This means you have to specify all the desired tags on each task affecting a network interface.
- If tags is omitted or None this option is disregarded.
+ 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.
+
|
@@ -452,8 +447,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -519,14 +513,13 @@ Parameters
dictionary
- added in 1.3.0
|
- A hash/dictionary of tags to add to the new ENI or to add/remove from an existing one. Please note that the name field sets the "Name" tag.
- To clear all tags, set this option to an empty dictionary to use in conjunction with purge_tags. If you provide name, that tag will not be removed.
- To prevent removing any tags set purge_tags to false.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -557,9 +550,9 @@ Notes
.. note::
- This module identifies and ENI based on either the *eni_id*, a combination of *private_ip_address* and *subnet_id*, or a combination of *instance_id* and *device_id*. Any of these options will let you specify a particular ENI.
+ - Support for *tags* and *purge_tags* was added in release 1.3.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_group_info_module.rst b/docs/amazon.aws.ec2_group_info_module.rst
index 6ed74e1c653..ef20b25e883 100644
--- a/docs/amazon.aws.ec2_group_info_module.rst
+++ b/docs/amazon.aws.ec2_group_info_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_group_info
*************************
-**Gather information about ec2 security groups in AWS.**
+**Gather information about ec2 security groups in AWS**
Version added: 1.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -174,8 +170,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -208,8 +203,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -244,7 +238,6 @@ Notes
- By default, the module will return all security groups. To limit results use the appropriate filters.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -309,25 +302,527 @@ Common return values are documented `here
- | Key |
+ Key |
Returned |
Description |
- |
+ |
security_groups
list
+ / elements=dictionary
|
always |
Security groups that match the provided filters. Each element consists of a dict with all the information related to that security group.
+ Sample:
+ [{'description': 'created by rds_instance integration tests', 'group_id': 'sg-036496a610b79da88', 'group_name': 'ansible-test-89355088-unknown5c5f67f3ad09-sg-1', 'ip_permissions': [], 'ip_permissions_egress': [{'ip_protocol': '-1', 'ip_ranges': [{'cidr_ip': '0.0.0.0/0'}], 'ipv6_ranges': [], 'prefix_list_ids': [], 'user_id_group_pairs': []}], 'owner_id': '721066863947', 'tags': {}, 'vpc_id': 'vpc-0bc3bb03f97405435'}]
+ |
+
+
+ | |
+
+
+ description
+
+
+ string
+
+ |
+ always |
+
+ The description of the security group.
+
+ |
+
+
+ | |
+
+
+ group_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the security group.
+
|
+
+ | |
+
+
+ group_name
+
+
+ string
+
+ |
+ always |
+
+ The name of the security group.
+
+ |
+
+
+ | |
+
+
+ ip_permissions
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The inbound rules associated with the security group.
+
+ |
+
+
+ | |
+ |
+
+
+ ip_protocol
+
+
+ string
+
+ |
+ always |
+
+ The IP protocol name or number.
+
+ |
+
+
+ | |
+ |
+
+
+ ip_ranges
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The IPv4 ranges.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ cidr_ip
+
+
+ string
+
+ |
+ always |
+
+ The IPv4 CIDR range.
+
+ |
+
+
+
+ | |
+ |
+
+
+ ipv6_ranges
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The IPv6 ranges.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ cidr_ipv6
+
+
+ string
+
+ |
+ always |
+
+ The IPv6 CIDR range.
+
+ |
+
+
+
+ | |
+ |
+
+
+ prefix_list_ids
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The prefix list IDs.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ prefix_list_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the prefix.
+
+ |
+
+
+
+ | |
+ |
+
+
+ user_id_group_pairs
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The security group and AWS account ID pairs.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ group_id
+
+
+ string
+
+ |
+ always |
+
+ The security group ID of the pair.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ user_id
+
+
+ string
+
+ |
+ always |
+
+ The user ID of the pair.
+
+ |
+
+
+
+
+ | |
+
+
+ ip_permissions_egress
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The outbound rules associated with the security group.
+
+ |
+
+
+ | |
+ |
+
+
+ ip_protocol
+
+
+ string
+
+ |
+ always |
+
+ The IP protocol name or number.
+
+ |
+
+
+ | |
+ |
+
+
+ ip_ranges
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The IPv4 ranges.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ cidr_ip
+
+
+ string
+
+ |
+ always |
+
+ The IPv4 CIDR range.
+
+ |
+
+
+
+ | |
+ |
+
+
+ ipv6_ranges
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The IPv6 ranges.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ cidr_ipv6
+
+
+ string
+
+ |
+ always |
+
+ The IPv6 CIDR range.
+
+ |
+
+
+
+ | |
+ |
+
+
+ prefix_list_ids
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The prefix list IDs.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ prefix_list_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the prefix.
+
+ |
+
+
+
+ | |
+ |
+
+
+ user_id_group_pairs
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ The security group and AWS account ID pairs.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ group_id
+
+
+ string
+
+ |
+ always |
+
+ The security group ID of the pair.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ user_id
+
+
+ string
+
+ |
+ always |
+
+ The user ID of the pair.
+
+ |
+
+
+
+
+ | |
+
+
+ owner_id
+
+
+ string
+
+ |
+ always |
+
+ The AWS account ID of the owner of the security group.
+
+ |
+
+
+ | |
+
+
+ tags
+
+
+ dictionary
+
+ |
+ always |
+
+ The tags associated with the security group.
+
+ |
+
+
+ | |
+
+
+ vpc_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the VPC for the security group.
+
+ |
+
+
diff --git a/docs/amazon.aws.ec2_group_module.rst b/docs/amazon.aws.ec2_group_module.rst
index 89161ea9583..f70b01c026a 100644
--- a/docs/amazon.aws.ec2_group_module.rst
+++ b/docs/amazon.aws.ec2_group_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_group
********************
-**maintain an ec2 VPC security group.**
+**Maintain an ec2 VPC security group**
Version added: 1.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -206,8 +202,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -249,6 +244,7 @@ Parameters
|
Purge existing rules_egress on security group that are not found in rules_egress.
+
aliases: purge_egress_rules
|
@@ -267,7 +263,9 @@ Parameters
|
- If yes, 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.
+ 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.
+
|
@@ -405,6 +403,44 @@ Parameters
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
+
+ |
+
+
+ icmp_code
+
+
+ integer
+
+ added in 3.3.0
+ |
+
+ |
+
+ When using icmp or icmpv6 as the protocol, allows you to specify
+ the ICMP code to use. The option is mutually exclusive with to_port.
+ A value of -1 indicates all ICMP codes.
+ |
+
+
+ |
+
+
+ icmp_type
+
+
+ integer
+
+ added in 3.3.0
+ |
+
+ |
+
+ When using icmp or icmpv6 as the protocol, allows you to
+ specify the ICMP type to use. The option is mutually exclusive with from_port.
+ A value of -1 indicates all ICMP types.
+ |
+
|
@@ -435,7 +471,11 @@ Parameters
|
|
-
+ The IP protocol name (tcp, udp, icmp, icmpv6) or
+
+ When using icmp or icmpv6 as the protocol, you can pass
+ the icmp_type and icmp_code parameters instead of
+ from_port and to_port.
|
@@ -487,6 +527,7 @@ Parameters
|
List of firewall outbound rules to enforce in this group (see example). If none are supplied, a default all-out rule is assumed. If an empty list is supplied, no outbound rules will be enabled. Rule Egress sources list support was added in version 2.4. In version 2.5 support for rule descriptions was added.
+
aliases: egress_rules
|
@@ -592,6 +633,44 @@ Parameters
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
+
+ |
+
+
+ icmp_code
+
+
+ integer
+
+ added in 3.3.0
+ |
+
+ |
+
+ When using icmp or icmpv6 as the protocol, allows you to specify
+ the ICMP code to use. The option is mutually exclusive with to_port.
+ A value of -1 indicates all ICMP codes.
+ |
+
+
+ |
+
+
+ icmp_type
+
+
+ integer
+
+ added in 3.3.0
+ |
+
+ |
+
+ When using icmp or icmpv6 as the protocol, allows you to specify
+ the ICMP type to use. The option is mutually exclusive with from_port.
+ A value of -1 indicates all ICMP types.
+ |
+
|
@@ -622,7 +701,10 @@ Parameters
|
|
-
+ The IP protocol name (tcp, udp, icmp, icmpv6) or
+
+ When using icmp or icmpv6 as the protocol, you can pass the
+ icmp_type and icmp_code parameters instead of from_port and to_port.
|
@@ -673,8 +755,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -710,7 +791,8 @@ Parameters
|
- A dictionary of one or more tags to assign to the security group.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -760,7 +842,6 @@ Notes
- Preview diff mode support is added in version 2.7.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -784,6 +865,19 @@ Examples
cidr_ip: 0.0.0.0/0
rule_desc: allow all on port 80
+ - name: example using ICMP types and codes
+ amazon.aws.ec2_group:
+ name: "{{ name }}"
+ description: sg for ICMP
+ vpc_id: vpc-xxxxxxxx
+ profile: "{{ aws_profile }}"
+ region: us-east-1
+ rules:
+ - proto: icmp
+ icmp_type: 3
+ icmp_code: 1
+ cidr_ip: 0.0.0.0/0
+
- name: example ec2 group
amazon.aws.ec2_group:
name: example
@@ -827,10 +921,11 @@ Examples
# the containing group name may be specified here
group_name: example
- proto: all
- # in the 'proto' attribute, if you specify -1 (only supported when I(proto=icmp)), all, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6),
- # traffic on all ports is allowed, regardless of any ports you specify
+ # in the 'proto' attribute, if you specify -1 (only supported when I(proto=icmp)), all, or a protocol number
+ # other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports that
+ # you specify.
from_port: 10050 # this value is ignored
- to_port: 10050 # this value is ignored
+ to_port: 10050 # this value is ignored
cidr_ip: 10.0.0.0/8
rules_egress:
@@ -850,7 +945,8 @@ Examples
vpc_id: 12345
region: eu-west-1
rules:
- # 'ports' rule keyword was introduced in version 2.4. It accepts a single port value or a list of values including ranges (from_port-to_port).
+ # 'ports' rule keyword was introduced in version 2.4. It accepts a single
+ # port value or a list of values including ranges (from_port-to_port).
- proto: tcp
ports: 22
group_name: example-vpn
@@ -860,7 +956,8 @@ Examples
- 443
- 8080-8099
cidr_ip: 0.0.0.0/0
- # Rule sources list support was added in version 2.4. This allows to define multiple sources per source type as well as multiple source types per rule.
+ # Rule sources list support was added in version 2.4. This allows to
+ # define multiple sources per source type as well as multiple source types per rule.
- proto: tcp
ports:
- 6379
@@ -1049,3 +1146,4 @@ Authors
~~~~~~~
- Andrew de Quincey (@adq)
+- Razique Mahroua (@Razique)
diff --git a/docs/amazon.aws.ec2_instance_info_module.rst b/docs/amazon.aws.ec2_instance_info_module.rst
index 83018c0315c..47ef4ddb43b 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -206,8 +202,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -240,8 +235,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -275,7 +269,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -344,7 +337,7 @@ Common return values are documented `here
always |
- a list of ec2 instances
+ A list of ec2 instances.
|
@@ -376,7 +369,7 @@ Common return values are documented `here
always |
- The architecture of the image
+ The architecture of the image.
Sample:
x86_64
@@ -508,7 +501,7 @@ Common return values are documented `here
always |
- The ID of the EBS volume
+ The ID of the EBS volume.
Sample:
vol-12345678
@@ -671,7 +664,7 @@ Common return values are documented `here
always |
- The ID of the instance profile
+ The ID of the instance profile.
Sample:
JFJ397FDG400FG9FD1N
@@ -1613,7 +1606,7 @@ Common return values are documented `here
always |
- The public IPv4 address assigned to the instance
+ The public IPv4 address assigned to the instance.
Sample:
52.0.0.1
@@ -1631,7 +1624,7 @@ Common return values are documented `here
always |
- The device name of the root device
+ The device name of the root device.
Sample:
/dev/sda1
diff --git a/docs/amazon.aws.ec2_instance_module.rst b/docs/amazon.aws.ec2_instance_module.rst
index 8457d32dc7b..d82ecb46d33 100644
--- a/docs/amazon.aws.ec2_instance_module.rst
+++ b/docs/amazon.aws.ec2_instance_module.rst
@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -72,8 +72,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -90,7 +89,6 @@ Parameters
|
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.
|
@@ -108,7 +106,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -124,8 +121,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -596,6 +592,45 @@ Parameters
If specified a value of disabled, metadata of the instance will not be accessible.
|
+
+ |
+
+
+ http_protocol_ipv6
+
+
+ string
+
+ added in 4.0.0
+ |
+
+ Choices:
+ - enabled
+ disabled ←
+ |
+
+ - Wether the instance metadata endpoint is available via IPv6 (enabled) or not (disabled). - Requires botocore >= 1.21.29
+ |
+
+
+ |
+
+
+ http_put_response_hop_limit
+
+
+ integer
+
+ added in 4.0.0
+ |
+
+ Default:
1
+ |
+
+ The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+ |
+
|
@@ -618,6 +653,28 @@ Parameters
If the state is required (v2), a signed token header must be sent with any instance metadata retrieval requests.
|
+
+ |
+
+
+ instance_metadata_tags
+
+
+ string
+
+ added in 4.0.0
+ |
+
+ Choices:
+ - enabled
+ disabled ←
+ |
+
+ Wether the instance tags are availble (enabled) via metadata endpoint or not (disabled).
+ Requires botocore >= 1.23.30
+ |
+
|
@@ -870,8 +927,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -886,12 +942,15 @@ Parameters
|
|
- Delete any tags not specified in the task that are on the instance. This means you have to specify all the desired tags on each task affecting an instance.
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -954,8 +1013,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -1005,7 +1063,9 @@ Parameters
|
- A hash/dictionary of tags to add to the new instance or to add/remove from an existing one.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -1161,8 +1221,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.iops, and ebs.delete_on_termination.
- Set ebs.throughput value requires botocore>=1.19.27.
+ 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.
|
@@ -1227,7 +1286,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -1277,6 +1335,17 @@ Examples
volume_size: 16
delete_on_termination: true
+ - name: start an instance and Add EBS volume from a snapshot
+ amazon.aws.ec2_instance:
+ name: "public-withebs-instance"
+ instance_type: t2.micro
+ image_id: ami-1234567890
+ vpc_subnet_id: subnet-5ca1ab1e
+ volumes:
+ - device_name: /dev/sda2
+ ebs:
+ snapshot_id: snap-1234567890
+
- name: start an instance with a cpu_options
amazon.aws.ec2_instance:
name: "public-cpuoption-instance"
diff --git a/docs/amazon.aws.ec2_key_module.rst b/docs/amazon.aws.ec2_key_module.rst
index 72658bcf5e6..05ed904fc04 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
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -232,8 +228,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -245,16 +240,18 @@ Parameters
boolean
- added in 2.1.0
|
|
- Delete any tags not specified in tags.
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -286,8 +283,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -319,12 +315,13 @@ Parameters
dictionary
- added in 2.1.0
|
- A dictionary of tags to set on the key pair.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -346,40 +343,6 @@ Parameters
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
-
- |
-
- wait
-
-
- boolean
-
- |
-
-
- |
-
- This option has no effect since version 2.5 and will be removed after 2022-06-01.
- |
-
-
- |
-
- wait_timeout
-
-
- integer
-
- |
-
- |
-
- This option has no effect since version 2.5 and will be removed after 2022-06-01.
- |
-
@@ -388,9 +351,9 @@ Notes
-----
.. note::
+ - Support for *tags* and *purge_tags* was added in release 2.1.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_metadata_facts_module.rst b/docs/amazon.aws.ec2_metadata_facts_module.rst
index 7d8f1a0eb94..494a56b2b2e 100644
--- a/docs/amazon.aws.ec2_metadata_facts_module.rst
+++ b/docs/amazon.aws.ec2_metadata_facts_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_metadata_facts
*****************************
-**gathers facts (instance metadata) about remote hosts within EC2**
+**Gathers facts (instance metadata) about remote hosts within EC2**
Version added: 1.0.0
diff --git a/docs/amazon.aws.ec2_module.rst b/docs/amazon.aws.ec2_module.rst
deleted file mode 100644
index e2f947f168b..00000000000
--- a/docs/amazon.aws.ec2_module.rst
+++ /dev/null
@@ -1,2078 +0,0 @@
-.. _amazon.aws.ec2_module:
-
-
-**************
-amazon.aws.ec2
-**************
-
-**create, terminate, start or stop an instance in ec2**
-
-
-Version added: 1.0.0
-
-.. contents::
- :local:
- :depth: 1
-
-DEPRECATED
-----------
-:Removed in collection release after
-:Why: The ec2 module is based upon a deprecated version of the AWS SDK.
-:Alternative: Use :ref:`amazon.aws.ec2_instance `.
-
-
-
-Synopsis
---------
-- Creates or terminates ec2 instances.
-- Note: This module uses the older boto Python module to interact with the EC2 API. :ref:`amazon.aws.ec2 ` will still receive bug fixes, but no new features. Consider using the :ref:`amazon.aws.ec2_instance ` module instead. If :ref:`amazon.aws.ec2_instance ` does not support a feature you need that is available in :ref:`amazon.aws.ec2 `, please file a feature request.
-
-
-
-
-Requirements
-------------
-The below requirements are needed on the host that executes this module.
-
-- boto
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
-- python >= 2.6
-- python >= 3.6
-
-
-Parameters
-----------
-
-.. raw:: html
-
-
-
- | Parameter |
- Choices/Defaults |
- Comments |
-
-
- |
-
- assign_public_ip
-
-
- boolean
-
- |
-
-
- |
-
- When provisioning within vpc, assign a public IP address. Boto library must be 2.13.0+.
- |
-
-
- |
-
- 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.
-
-
- |
-
-
- |
-
- 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
- |
-
-
- |
-
- count
-
-
- integer
-
- |
-
- Default:
1
- |
-
- Number of instances to launch.
- |
-
-
- |
-
- count_tag
-
-
- raw
-
- |
-
- |
-
- Used with exact_count to determine how many nodes based on a specific tag criteria should be running. This can be expressed in multiple ways and is shown in the EXAMPLES section. For instance, one can request 25 servers that are tagged with class=webserver. The specified tag must already exist or be passed in as the instance_tags option.
- |
-
-
- |
-
- debug_botocore_endpoint_logs
-
-
- boolean
-
- |
-
-
- |
-
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
- |
-
-
- |
-
- ebs_optimized
-
-
- boolean
-
- |
-
-
- |
-
-
- |
-
-
- |
-
- 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
- |
-
-
- |
-
- exact_count
-
-
- integer
-
- |
-
- |
-
- An integer value which indicates how many instances that match the 'count_tag' parameter should be running. Instances are either created or terminated based on this value.
- |
-
-
- |
-
- group
-
-
- list
- / elements=string
-
- |
-
- |
-
- Security group (or list of groups) to use with the instance.
-
aliases: groups
- |
-
-
- |
-
- group_id
-
-
- list
- / elements=string
-
- |
-
- |
-
- Security group id (or list of ids) to use with the instance.
- |
-
-
- |
-
- id
-
-
- string
-
- |
-
- |
-
- Identifier for this instance or set of instances, so that the module will be idempotent with respect to EC2 instances.
- This identifier is valid for at least 24 hours after the termination of the instance, and should not be reused for another call later on.
-
- |
-
-
- |
-
- image
-
-
- string
-
- |
-
- |
-
- ami ID to use for the instance.
- Required when state=present.
- |
-
-
- |
-
- instance_ids
-
-
- list
- / elements=string
-
- |
-
- |
-
- list of instance ids, currently used for states: absent, running, stopped
-
aliases: instance_id
- |
-
-
- |
-
- instance_initiated_shutdown_behavior
-
-
- string
-
- |
-
- Choices:
- stop ← - terminate
-
- |
-
- Set whether AWS will Stop or Terminate an instance on shutdown. This parameter is ignored when using instance-store. images (which require termination on shutdown).
- |
-
-
- |
-
- instance_profile_name
-
-
- string
-
- |
-
- |
-
- Name of the IAM instance profile (i.e. what the EC2 console refers to as an "IAM Role") to use. Boto library must be 2.5.0+.
- |
-
-
- |
-
- instance_tags
-
-
- dictionary
-
- |
-
- |
-
- A hash/dictionary of tags to add to the new instance or for instances to start/stop by tag. For example {"key":"value"} or {"key":"value","key2":"value2"}.
- |
-
-
- |
-
- instance_type
-
-
- string
-
- |
-
- |
-
-
- Required when creating a new instance.
-
aliases: type
- |
-
-
- |
-
- kernel
-
-
- string
-
- |
-
- |
-
- Kernel eki to use for the instance.
- |
-
-
- |
-
- key_name
-
-
- string
-
- |
-
- |
-
- Key pair to use on the instance.
- The SSH key must already exist in AWS in order to use this argument.
- Keys can be created / deleted using the amazon.aws.ec2_key module.
-
aliases: keypair
- |
-
-
- |
-
- monitoring
-
-
- boolean
-
- |
-
-
- |
-
- Enable detailed monitoring (CloudWatch) for the instance.
- |
-
-
- |
-
- network_interfaces
-
-
- list
- / elements=string
-
- |
-
- |
-
- A list of existing network interfaces to attach to the instance at launch. When specifying existing network interfaces, none of the assign_public_ip, private_ip, vpc_subnet_id, group, or group_id parameters may be used. (Those parameters are for creating a new network interface at launch.)
-
aliases: network_interface
- |
-
-
- |
-
- placement_group
-
-
- string
-
- |
-
- |
-
- Placement group for the instance when using EC2 Clustered Compute.
- |
-
-
- |
-
- private_ip
-
-
- string
-
- |
-
- |
-
- The private ip address to assign the instance (from the vpc subnet).
- |
-
-
- |
-
- 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
- |
-
-
- |
-
- ramdisk
-
-
- string
-
- |
-
- |
-
- Ramdisk eri to use for the instance.
- |
-
-
- |
-
- region
-
-
- string
-
- |
-
- |
-
-
-
aliases: aws_region, ec2_region
- |
-
-
- |
-
- security_token
-
-
- string
-
- |
-
- |
-
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
- Aliases aws_session_token and session_token have been added in version 3.2.0.
-
aliases: aws_session_token, session_token, aws_security_token, access_token
- |
-
-
- |
-
- source_dest_check
-
-
- boolean
-
- |
-
-
- |
-
- Enable or Disable the Source/Destination checks (for NAT instances and Virtual Routers). When initially creating an instance the EC2 API defaults this to True.
- |
-
-
- |
-
- spot_launch_group
-
-
- string
-
- |
-
- |
-
-
- |
-
-
- |
-
- spot_price
-
-
- string
-
- |
-
- |
-
- Maximum spot price to bid. If not set, a regular on-demand instance is requested.
- A spot request is made with this maximum bid. When it is filled, the instance is started.
- |
-
-
- |
-
- spot_type
-
-
- string
-
- |
-
- Choices:
- one-time ← - persistent
-
- |
-
- The type of spot request.
- After being interrupted a persistent spot instance will be started once there is capacity to fill the request again.
- |
-
-
- |
-
- spot_wait_timeout
-
-
- integer
-
- |
-
- Default:
600
- |
-
- How long to wait for the spot instance request to be fulfilled. Affects 'Request valid until' for setting spot request lifespan.
- |
-
-
- |
-
- state
-
-
- string
-
- |
-
- Choices:
- - absent
- present ← - restarted
- - running
- - stopped
-
- |
-
- 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.
- |
-
-
- |
-
- tenancy
-
-
- string
-
- |
-
- Choices:
- default ← - dedicated
-
- |
-
- An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.
- Note that to use dedicated tenancy you MUST specify a vpc_subnet_id as well.
- Dedicated tenancy is not available for EC2 "micro" instances.
- |
-
-
- |
-
- termination_protection
-
-
- boolean
-
- |
-
-
- |
-
- Enable or Disable the Termination Protection.
- Defaults to false.
- |
-
-
- |
-
- user_data
-
-
- string
-
- |
-
- |
-
- Opaque blob of data which is made available to the EC2 instance.
- |
-
-
- |
-
- validate_certs
-
-
- boolean
-
- |
-
-
- |
-
- When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
- |
-
-
- |
-
- volumes
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- A list of hash/dictionaries of volumes to add to the new instance.
- |
-
-
- |
-
-
- delete_on_termination
-
-
- boolean
-
- |
-
-
- |
-
- Whether the volume should be automatically deleted when the instance is terminated.
- |
-
-
- |
-
-
- device_name
-
-
- string
- / required
-
- |
-
- |
-
- A name for the device (For example /dev/sda).
- |
-
-
- |
-
-
- encrypted
-
-
- boolean
-
- |
-
-
- |
-
- Whether the volume should be encrypted using the 'aws/ebs' KMS CMK.
- |
-
-
- |
-
-
- ephemeral
-
-
- string
-
- |
-
- |
-
- Whether the volume should be ephemeral.
- Data on ephemeral volumes is lost when the instance is stopped.
- Mutually exclusive with the snapshot parameter.
- |
-
-
- |
-
-
- iops
-
-
- integer
-
- |
-
- |
-
- The number of IOPS per second to provision for the volume.
- Required when volume_type=io1.
- |
-
-
- |
-
-
- snapshot
-
-
- string
-
- |
-
- |
-
- The ID of an EBS snapshot to copy when creating the volume.
- Mutually exclusive with the ephemeral parameter.
- |
-
-
- |
-
-
- volume_size
-
-
- integer
-
- |
-
- |
-
- The size of the volume (in GiB).
- |
-
-
- |
-
-
- volume_type
-
-
- string
-
- |
-
- |
-
- The type of volume to create.
-
- |
-
-
-
- |
-
- vpc_subnet_id
-
-
- string
-
- |
-
- |
-
- The subnet ID in which to launch the instance (VPC).
- |
-
-
- |
-
- wait
-
-
- boolean
-
- |
-
-
- |
-
- Wait for the instance to reach its desired state before returning.
- Does not wait for SSH, see the 'wait_for_connection' example for details.
- |
-
-
- |
-
- wait_timeout
-
-
- integer
-
- |
-
- Default:
300
- |
-
- How long before wait gives up, in seconds.
- |
-
-
- |
-
- zone
-
-
- string
-
- |
-
- |
-
- AWS availability zone in which to launch the instance.
-
aliases: aws_zone, ec2_zone
- |
-
-
-
-
-
-Notes
------
-
-.. note::
- - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
-
-
-
-Examples
---------
-
-.. code-block:: yaml
-
- # Note: These examples do not set authentication details, see the AWS Guide for details.
-
- # Basic provisioning example
- - amazon.aws.ec2:
- key_name: mykey
- instance_type: t2.micro
- image: ami-123456
- wait: yes
- group: webserver
- count: 3
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- # Advanced example with tagging and CloudWatch
- - amazon.aws.ec2:
- key_name: mykey
- group: databases
- instance_type: t2.micro
- image: ami-123456
- wait: yes
- wait_timeout: 500
- count: 5
- instance_tags:
- db: postgres
- monitoring: yes
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- # Single instance with additional IOPS volume from snapshot and volume delete on termination
- - amazon.aws.ec2:
- key_name: mykey
- group: webserver
- instance_type: c3.medium
- image: ami-123456
- wait: yes
- wait_timeout: 500
- volumes:
- - device_name: /dev/sdb
- snapshot: snap-abcdef12
- volume_type: io1
- iops: 1000
- volume_size: 100
- delete_on_termination: true
- monitoring: yes
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- # Single instance with ssd gp2 root volume
- - amazon.aws.ec2:
- key_name: mykey
- group: webserver
- instance_type: c3.medium
- image: ami-123456
- wait: yes
- wait_timeout: 500
- volumes:
- - device_name: /dev/xvda
- volume_type: gp2
- volume_size: 8
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
- count_tag:
- Name: dbserver
- exact_count: 1
-
- # Multiple groups example
- - amazon.aws.ec2:
- key_name: mykey
- group: ['databases', 'internal-services', 'sshable', 'and-so-forth']
- instance_type: m1.large
- image: ami-6e649707
- wait: yes
- wait_timeout: 500
- count: 5
- instance_tags:
- db: postgres
- monitoring: yes
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- # Multiple instances with additional volume from snapshot
- - amazon.aws.ec2:
- key_name: mykey
- group: webserver
- instance_type: m1.large
- image: ami-6e649707
- wait: yes
- wait_timeout: 500
- count: 5
- volumes:
- - device_name: /dev/sdb
- snapshot: snap-abcdef12
- volume_size: 10
- monitoring: yes
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- # Dedicated tenancy example
- - amazon.aws.ec2:
- assign_public_ip: yes
- group_id: sg-1dc53f72
- key_name: mykey
- image: ami-6e649707
- instance_type: m1.small
- tenancy: dedicated
- vpc_subnet_id: subnet-29e63245
- wait: yes
-
- # Spot instance example
- - amazon.aws.ec2:
- spot_price: 0.24
- spot_wait_timeout: 600
- keypair: mykey
- group_id: sg-1dc53f72
- instance_type: m1.small
- image: ami-6e649707
- wait: yes
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
- spot_launch_group: report_generators
- instance_initiated_shutdown_behavior: terminate
-
- # Examples using pre-existing network interfaces
- - amazon.aws.ec2:
- key_name: mykey
- instance_type: t2.small
- image: ami-f005ba11
- network_interface: eni-deadbeef
-
- - amazon.aws.ec2:
- key_name: mykey
- instance_type: t2.small
- image: ami-f005ba11
- network_interfaces: ['eni-deadbeef', 'eni-5ca1ab1e']
-
- # Launch instances, runs some tasks
- # and then terminate them
-
- - name: Create a sandbox instance
- hosts: localhost
- gather_facts: False
- vars:
- keypair: my_keypair
- instance_type: m1.small
- security_group: my_securitygroup
- image: my_ami_id
- region: us-east-1
- tasks:
- - name: Launch instance
- amazon.aws.ec2:
- key_name: "{{ keypair }}"
- group: "{{ security_group }}"
- instance_type: "{{ instance_type }}"
- image: "{{ image }}"
- wait: true
- region: "{{ region }}"
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
- register: ec2
-
- - name: Add new instance to host group
- add_host:
- hostname: "{{ item.public_ip }}"
- groupname: launched
- loop: "{{ ec2.instances }}"
-
- - name: Wait for SSH to come up
- delegate_to: "{{ item.public_dns_name }}"
- wait_for_connection:
- delay: 60
- timeout: 320
- loop: "{{ ec2.instances }}"
-
- - name: Configure instance(s)
- hosts: launched
- become: True
- gather_facts: True
- roles:
- - my_awesome_role
- - my_awesome_test
-
- - name: Terminate instances
- hosts: localhost
- tasks:
- - name: Terminate instances that were previously launched
- amazon.aws.ec2:
- state: 'absent'
- instance_ids: '{{ ec2.instance_ids }}'
-
- # Start a few existing instances, run some tasks
- # and stop the instances
-
- - name: Start sandbox instances
- hosts: localhost
- gather_facts: false
- vars:
- instance_ids:
- - 'i-xxxxxx'
- - 'i-xxxxxx'
- - 'i-xxxxxx'
- region: us-east-1
- tasks:
- - name: Start the sandbox instances
- amazon.aws.ec2:
- instance_ids: '{{ instance_ids }}'
- region: '{{ region }}'
- state: running
- wait: True
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
- roles:
- - do_neat_stuff
- - do_more_neat_stuff
-
- - name: Stop sandbox instances
- hosts: localhost
- gather_facts: false
- vars:
- instance_ids:
- - 'i-xxxxxx'
- - 'i-xxxxxx'
- - 'i-xxxxxx'
- region: us-east-1
- tasks:
- - name: Stop the sandbox instances
- amazon.aws.ec2:
- instance_ids: '{{ instance_ids }}'
- region: '{{ region }}'
- state: stopped
- wait: True
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- #
- # Start stopped instances specified by tag
- #
- - amazon.aws.ec2:
- instance_tags:
- Name: ExtraPower
- state: running
-
- #
- # Restart instances specified by tag
- #
- - amazon.aws.ec2:
- instance_tags:
- Name: ExtraPower
- state: restarted
-
- #
- # Enforce that 5 instances with a tag "foo" are running
- # (Highly recommended!)
- #
-
- - amazon.aws.ec2:
- key_name: mykey
- instance_type: c1.medium
- image: ami-40603AD1
- wait: yes
- group: webserver
- instance_tags:
- foo: bar
- exact_count: 5
- count_tag: foo
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- #
- # Enforce that 5 running instances named "database" with a "dbtype" of "postgres"
- #
-
- - amazon.aws.ec2:
- key_name: mykey
- instance_type: c1.medium
- image: ami-40603AD1
- wait: yes
- group: webserver
- instance_tags:
- Name: database
- dbtype: postgres
- exact_count: 5
- count_tag:
- Name: database
- dbtype: postgres
- vpc_subnet_id: subnet-29e63245
- assign_public_ip: yes
-
- #
- # count_tag complex argument examples
- #
-
- # instances with tag foo
- - amazon.aws.ec2:
- count_tag:
- foo:
-
- # instances with tag foo=bar
- - amazon.aws.ec2:
- count_tag:
- foo: bar
-
- # instances with tags foo=bar & baz
- - amazon.aws.ec2:
- count_tag:
- foo: bar
- baz:
-
- # instances with tags foo & bar & baz=bang
- - amazon.aws.ec2:
- count_tag:
- - foo
- - bar
- - baz: bang
-
-
-
-Return Values
--------------
-Common return values are documented `here `_, the following are the fields unique to this module:
-
-.. raw:: html
-
-
-
- | Key |
- Returned |
- Description |
-
-
- |
-
- changed
-
-
- boolean
-
- |
- always |
-
- If the EC2 instance has changed.
-
- Sample:
- True
- |
-
-
- |
-
- instances
-
-
- list
-
- |
- always |
-
- The instances.
-
- |
-
-
- | |
-
-
- ami_launch_index
-
-
- integer
-
- |
- always |
-
- The AMI launch index, which can be used to find this instance in the launch group.
-
- |
-
-
- | |
-
-
- architecture
-
-
- string
-
- |
- always |
-
- The architecture of the image.
-
- Sample:
- x86_64
- |
-
-
- | |
-
-
- block_device_mapping
-
-
- dictionary
-
- |
- always |
-
- Any block device mapping entries for the instance.
-
- Sample:
- {'/dev/xvda': {'delete_on_termination': True, 'status': 'attached', 'volume_id': 'vol-06d364586f5550b62'}}
- |
-
-
- | |
-
-
- capacity_reservation_specification
-
-
- dictionary
-
- |
- always |
-
- Information about the Capacity Reservation targeting option.
-
- Sample:
- {'capacity_reservation_preference': 'open'}
- |
-
-
- | |
-
-
- client_token
-
-
- string
-
- |
- always |
-
- The idempotency token you provided when you launched the instance, if applicable.
-
- |
-
-
- | |
-
-
- cpu_options
-
-
- dictionary
-
- |
- always |
-
- The CPU options for the instance.
-
- Sample:
- {'core_count': 1, 'threads_per_core': 1}
- |
-
-
- | |
-
-
- dns_name
-
-
- string
-
- |
- always |
-
- The public DNS name assigned to the instance.
-
- Sample:
- ec2-203-0-113-1.z-2.compute-1.amazonaws.com
- |
-
-
- | |
-
-
- ebs_optimized
-
-
- boolean
-
- |
- always |
-
- Indicates whether the instance is optimized for Amazon EBS I/O.
-
- |
-
-
- | |
-
-
- ena_support
-
-
- boolean
-
- |
- always |
-
- Specifies whether enhanced networking with ENA is enabled.
-
- Sample:
- True
- |
-
-
- | |
-
-
- enclave_options
-
-
- dictionary
-
- |
- always |
-
- Indicates whether the instance is enabled for AWS Nitro Enclaves.
-
- Sample:
- {'enabled': False}
- |
-
-
- | |
-
-
- groups
-
-
- dictionary
-
- |
- always |
-
- One or more security groups.
-
- Sample:
- {'sg-0c6562ab3d435619f': 'ansible-test--88312190_setup'}
- |
-
-
- | |
-
-
- hibernation_options
-
-
- dictionary
-
- |
- always |
-
- Indicates whether the instance is enabled for hibernation.
-
- Sample:
- {'configured': False}
- |
-
-
- | |
-
-
- hypervisor
-
-
- string
-
- |
- always |
-
- The hypervisor type of the instance.
-
- Sample:
- xen
- |
-
-
- | |
-
-
- image_id
-
-
- string
-
- |
- always |
-
- The ID of the AMI used to launch the instance.
-
- Sample:
- ami-0d5eff06f840b45e9
- |
-
-
- | |
-
-
- instance_id
-
-
- string
-
- |
- always |
-
- The ID of the instance.
-
- Sample:
- i-0250719204c428be1
- |
-
-
- | |
-
-
- instance_type
-
-
- string
-
- |
- always |
-
- The instance type.
-
- Sample:
- t2.micro
- |
-
-
- | |
-
-
- kernel
-
-
- string
-
- |
- always |
-
- The kernel associated with this instance, if applicable.
-
- |
-
-
- | |
-
-
- key_name
-
-
- string
-
- |
- always |
-
- The name of the key pair, if this instance was launched with an associated key pair.
-
- Sample:
- ansible-test-88312190_setup
- |
-
-
- | |
-
-
- launch_time
-
-
- string
-
- |
- always |
-
- The time the instance was launched.
-
- Sample:
- 2021-05-09T19:30:26.000Z
- |
-
-
- | |
-
-
- metadata
-
-
- dictionary
-
- |
- always |
-
- The metadata options for the instance.
-
- Sample:
- {'http_endpoint': 'enabled', 'http_put_response_hop_limit': 1, 'http_tokens': 'optional', 'state': 'applied'}
- |
-
-
- | |
-
-
- monitoring
-
-
- dictionary
-
- |
- always |
-
- The monitoring for the instance.
-
- Sample:
- {'state': 'disabled'}
- |
-
-
- | |
-
-
- network_interfaces
-
-
- list
-
- |
- always |
-
- The network interfaces for the instance.
-
- Sample:
- [{'attachment': {'attach_time': '2021-05-09T19:30:57+00:00', 'attachment_id': 'eni-attach-07341f2560be6c8fc', 'delete_on_termination': True, 'device_index': 0, 'network_card_index': 0, 'status': 'attached'}, 'description': '', 'groups': [{'group_id': 'sg-0c6562ab3d435619f', 'group_name': 'ansible-test-88312190_setup'}], 'interface_type': 'interface', 'ipv6_addresses': [], 'mac_address': '0e:0e:36:60:67:cf', 'network_interface_id': 'eni-061dee20eba3b445a', 'owner_id': '721066863947', 'private_dns_name': 'ip-10-176-1-178.ec2.internal', 'private_ip_address': '10.176.1.178', 'private_ip_addresses': [{'primary': True, 'private_dns_name': 'ip-10-176-1-178.ec2.internal', 'private_ip_address': '10.176.1.178'}], 'source_dest_check': True, 'status': 'in-use', 'subnet_id': 'subnet-069d3e2eab081955d', 'vpc_id': 'vpc-0b6879b6ca2e9be2b'}]
- |
-
-
- | |
-
-
- placement
-
-
- dictionary
-
- |
- always |
-
- The location where the instance launched, if applicable.
-
- Sample:
- {'availability_zone': 'us-east-1a', 'group_name': '', 'tenancy': 'default'}
- |
-
-
- | |
-
-
- private_dns_name
-
-
- string
-
- |
- always |
-
- The private DNS hostname name assigned to the instance.
-
- Sample:
- ip-10-176-1-249.ec2.internal
- |
-
-
- | |
-
-
- private_ip
-
-
- string
-
- |
- always |
-
- The private IPv4 address assigned to the instance.
-
- Sample:
- 10.176.1.249
- |
-
-
- | |
-
-
- public_dns_name
-
-
- string
-
- |
- always |
-
- The public DNS name assigned to the instance.
-
- Sample:
- ec2-203-0-113-1.z-2.compute-1.amazonaws.com
- |
-
-
- | |
-
-
- public_ip
-
-
- string
-
- |
- always |
-
- The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
-
- Sample:
- 203.0.113.1
- |
-
-
- | |
-
-
- ramdisk
-
-
- string
-
- |
- always |
-
- The RAM disk associated with this instance, if applicable.
-
- |
-
-
- | |
-
-
- root_device_name
-
-
- string
-
- |
- always |
-
- The device name of the root device volume.
-
- Sample:
- /dev/xvda
- |
-
-
- | |
-
-
- root_device_type
-
-
- string
-
- |
- always |
-
- The root device type used by the AMI.
-
- Sample:
- ebs
- |
-
-
- | |
-
-
- security_groups
-
-
- list
-
- |
- always |
-
- The security groups for the instance.
-
- Sample:
- [{'group_id': 'sg-0c6562ab3d435619f', 'group_name': 'ansible-test-alinas-mbp-88312190_setup'}]
- |
-
-
- | |
-
-
- source_dest_check
-
-
- boolean
-
- |
- always |
-
- Indicates whether source/destination checking is enabled.
-
- Sample:
- True
- |
-
-
- | |
-
-
- state
-
-
- dictionary
-
- |
- always |
-
- The current state of the instance.
-
- Sample:
- {'code': 80, 'name': 'stopped'}
- |
-
-
- | |
-
-
- state_reason
-
-
- dictionary
-
- |
- always |
-
- The reason for the most recent state transition.
-
- Sample:
- {'code': 'Client.UserInitiatedShutdown', 'message': 'Client.UserInitiatedShutdown: User initiated shutdown'}
- |
-
-
- | |
-
-
- state_transition_reason
-
-
- string
-
- |
- always |
-
- The reason for the most recent state transition. This might be an empty string.
-
- Sample:
- User initiated (2021-05-09 19:31:28 GMT)
- |
-
-
- | |
-
-
- subnet_id
-
-
- string
-
- |
- always |
-
- The ID of the subnet in which the instance is running.
-
- Sample:
- subnet-069d3e2eab081955d
- |
-
-
- | |
-
-
- tags
-
-
- dictionary
-
- |
- always |
-
- Any tags assigned to the instance.
-
- Sample:
- {'ResourcePrefix': 'ansible-test-88312190-integration_tests'}
- |
-
-
- | |
-
-
- tenancy
-
-
- string
-
- |
- always |
-
- The tenancy of the instance (if the instance is running in a VPC).
-
- Sample:
- default
- |
-
-
- | |
-
-
- virtualization_type
-
-
- string
-
- |
- always |
-
- The virtualization type of the instance.
-
- Sample:
- hvm
- |
-
-
- | |
-
-
- vpc_id
-
-
- string
-
- |
- always |
-
- The ID of the VPC in which the instance is running.
-
- Sample:
- vpc-0b6879b6ca2e9be2b
- |
-
-
-
-
-
-
-Status
-------
-
-
-- This module will be removed in version 4.0.0. *[deprecated]*
-- For more information see `DEPRECATED`_.
-
-
-Authors
-~~~~~~~
-
-- Tim Gerla (@tgerla)
-- Lester Wade (@lwade)
-- Seth Vidal (@skvidal)
diff --git a/docs/amazon.aws.ec2_snapshot_info_module.rst b/docs/amazon.aws.ec2_snapshot_info_module.rst
index ce8fe865741..ccdce99b1b7 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -228,8 +224,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -279,8 +274,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -332,7 +326,6 @@ Notes
- By default, the module will return all snapshots, including public ones. To limit results to snapshots owned by the account use the filter 'owner-id'.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -419,7 +412,7 @@ Common return values are documented `here
success |
- snapshots retrieved
+ List of snapshots retrieved with their respective info.
|
diff --git a/docs/amazon.aws.ec2_snapshot_module.rst b/docs/amazon.aws.ec2_snapshot_module.rst
index 28f74ba7862..db618f79b3d 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -219,8 +215,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -253,8 +248,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -388,7 +382,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_spot_instance_info_module.rst b/docs/amazon.aws.ec2_spot_instance_info_module.rst
index 7691a5de8c7..4d0419cc1ae 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -176,8 +172,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -210,8 +205,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -261,7 +255,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -303,17 +296,18 @@ Common return values are documented `here
- | Key |
+ Key |
Returned |
Description |
- |
+ |
spot_request
- dictionary
+ list
+ / elements=dictionary
|
when success |
@@ -324,6 +318,517 @@ Common return values are documented `here {'create_time': '2021-09-01T21:05:57+00:00', 'instance_id': 'i-08877936b801ac475', 'instance_interruption_behavior': 'terminate', 'launch_specification': {'ebs_optimized': False, 'image_id': 'ami-0443305dabd4be2bc', 'instance_type': 't2.medium', 'key_name': 'zuul', 'monitoring': {'enabled': False}, 'placement': {'availability_zone': 'us-east-2b'}, 'security_groups': [{'group_id': 'sg-01f9833207d53b937', 'group_name': 'default'}], 'subnet_id': 'subnet-07d906b8358869bda'}, 'launched_availability_zone': 'us-east-2b', 'product_description': 'Linux/UNIX', 'spot_instance_request_id': 'sir-c3cp9jsk', 'spot_price': '0.046400', 'state': 'active', 'status': {'code': 'fulfilled', 'message': 'Your spot request is fulfilled.', 'update_time': '2021-09-01T21:05:59+00:00'}, 'tags': {}, 'type': 'one-time', 'valid_until': '2021-09-08T21:05:57+00:00'}
+
+ | |
+
+
+ create_time
+
+
+ string
+
+ |
+ always |
+
+ The date and time when the Spot Instance request was created.
+
+ |
+
+
+ | |
+
+
+ instance_id
+
+
+ string
+
+ |
+ when instance exists |
+
+ The instance ID, if an instance has been launched to fulfill the Spot Instance request.
+
+ |
+
+
+ | |
+
+
+ instance_interruption_behavior
+
+
+ string
+
+ |
+ always |
+
+ The behavior when a Spot Instance is interruped.
+
+ |
+
+
+ | |
+
+
+ launch_specification
+
+
+ dictionary
+
+ |
+ always |
+
+ Additional information for launching instances.
+
+ |
+
+
+ | |
+ |
+
+
+ ebs_optimized
+
+
+ boolean
+
+ |
+ always |
+
+ Indicates whether the instance is optimized for EBS I/O.
+
+ |
+
+
+ | |
+ |
+
+
+ image_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the AMI.
+
+ |
+
+
+ | |
+ |
+
+
+ instance_type
+
+
+ string
+
+ |
+ always |
+
+ The instance type.
+
+ |
+
+
+ | |
+ |
+
+
+ key_name
+
+
+ string
+
+ |
+ always |
+
+ The name of the key pair.
+
+ |
+
+
+ | |
+ |
+
+
+ monitoring
+
+
+ dictionary
+
+ |
+ always |
+
+ Described the monitoring of an instance.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ enabled
+
+
+ boolean
+
+ |
+ always |
+
+ Indicated whether detailed monitoring is enabled.
+
+ |
+
+
+
+ | |
+ |
+
+
+ placement
+
+
+ dictionary
+
+ |
+ always |
+
+ The placement information for the instance.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ availability_zone
+
+
+ string
+
+ |
+ always |
+
+ The name of the availability zone.
+
+ |
+
+
+
+ | |
+ |
+
+
+ security_groups
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of security groups.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ group_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the security group.
+
+ |
+
+
+ | |
+ |
+ |
+
+
+ group_name
+
+
+ string
+
+ |
+ always |
+
+ The name of the security group.
+
+ |
+
+
+
+ | |
+ |
+
+
+ subnet_id
+
+
+ string
+
+ |
+ when creating a network interface when launching an instance |
+
+ The ID of the subnet.
+
+ |
+
+
+
+ | |
+
+
+ launched_availability_zone
+
+
+ string
+
+ |
+ always |
+
+ The availability zone in which the request is launched.
+
+ |
+
+
+ | |
+
+
+ product_description
+
+
+ string
+
+ |
+ always |
+
+ The product description associated with the Spot Instance.
+
+ |
+
+
+ | |
+
+
+ spot_instance_request_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the Spot Instance request.
+
+ |
+
+
+ | |
+
+
+ spot_price
+
+
+ string
+
+ |
+ always |
+
+ The maximum price per hour that you are willing to pay for a Spot Instance.
+
+ |
+
+
+ | |
+
+
+ state
+
+
+ string
+
+ |
+ always |
+
+ The state of the Spot Instance request.
+
+ |
+
+
+ | |
+
+
+ status
+
+
+ dictionary
+
+ |
+ always |
+
+ Extra information about the status of the Spot Instance request.
+
+ |
+
+
+ | |
+ |
+
+
+ code
+
+
+ string
+
+ |
+ always |
+
+ The status code.
+ See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand for codes.
+
+ |
+
+
+ | |
+ |
+
+
+ message
+
+
+ string
+
+ |
+ always |
+
+ The description of the status code.
+
+ |
+
+
+ | |
+ |
+
+
+ update_time
+
+
+ string
+
+ |
+ always |
+
+ The date and time of the most recent status update in UTC format.
+
+ |
+
+
+
+ | |
+
+
+ tags
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of tags associated with the resource.
+
+ |
+
+
+ | |
+ |
+
+
+ key
+
+
+ string
+
+ |
+ always |
+
+ The key of the tag.
+
+ |
+
+
+ | |
+ |
+
+
+ value
+
+
+ string
+
+ |
+ always |
+
+ The value of the tag.
+
+ |
+
+
+
+ | |
+
+
+ type
+
+
+ string
+
+ |
+ always |
+
+ The Spot Instance request type.
+
+ |
+
+
+ | |
+
+
+ valid_until
+
+
+ string
+
+ |
+ always |
+
+ The end date of the request in UTC format.
+
+ |
+
+
diff --git a/docs/amazon.aws.ec2_spot_instance_module.rst b/docs/amazon.aws.ec2_spot_instance_module.rst
index 7ef4904ba3e..d679a70598f 100644
--- a/docs/amazon.aws.ec2_spot_instance_module.rst
+++ b/docs/amazon.aws.ec2_spot_instance_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_spot_instance
****************************
-**request, stop, reboot or cancel spot instance**
+**Request, stop, reboot or cancel spot instance**
Version added: 2.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -1042,8 +1038,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -1076,8 +1071,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -1216,7 +1210,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_tag_info_module.rst b/docs/amazon.aws.ec2_tag_info_module.rst
index 9f375fb4cdb..1c442b461c5 100644
--- a/docs/amazon.aws.ec2_tag_info_module.rst
+++ b/docs/amazon.aws.ec2_tag_info_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_tag_info
***********************
-**list tags on ec2 resources**
+**List tags on ec2 resources**
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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -56,8 +56,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -74,7 +73,6 @@ Parameters
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.
|
@@ -92,7 +90,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -108,8 +105,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -160,8 +156,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -210,8 +205,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -245,7 +239,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_tag_module.rst b/docs/amazon.aws.ec2_tag_module.rst
index ea85c2fa632..04bb26f50d3 100644
--- a/docs/amazon.aws.ec2_tag_module.rst
+++ b/docs/amazon.aws.ec2_tag_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_tag
******************
-**create and remove tags on ec2 resources**
+**Create and remove tags on ec2 resources**
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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -56,8 +56,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -74,7 +73,6 @@ Parameters
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.
|
@@ -92,7 +90,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -108,8 +105,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -160,8 +156,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -230,8 +225,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -249,12 +243,11 @@ Parameters
Choices:
present ←
- absent
- - list
Whether the tags should be present or absent on the resource.
- The use of state=list to interrogate the tags of an instance has been deprecated and will be removed after 2022-06-01. The 'list' functionality has been moved to a dedicated module amazon.aws.ec2_tag_info.
+ The use of state=list to interrogate the tags of an instance was deprecated in release 1.0.0 and is no longer available in release 4.0.0. The 'list' functionality has been moved to a dedicated module amazon.aws.ec2_tag_info.
|
@@ -264,6 +257,7 @@ Parameters
dictionary
+ / required
@@ -271,7 +265,6 @@ Parameters
|
A dictionary of tags to add or remove from the resource.
If the value provided for a key is not set and state=absent, the tag will be removed regardless of its current value.
- Required when state=present or state=absent.
|
@@ -303,7 +296,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vol_info_module.rst b/docs/amazon.aws.ec2_vol_info_module.rst
index 5dfcf21f8a0..405dee93833 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -174,8 +170,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -208,8 +203,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -243,7 +237,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst
index e6e863c651c..bb0a1c37a8f 100644
--- a/docs/amazon.aws.ec2_vol_module.rst
+++ b/docs/amazon.aws.ec2_vol_module.rst
@@ -27,8 +27,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -55,8 +55,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -73,7 +72,6 @@ Parameters
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.
|
@@ -91,7 +89,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -107,8 +104,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -346,8 +342,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -359,16 +354,18 @@ Parameters
boolean
- added in 1.5.0
|
- Whether to remove existing tags that aren't passed in the tags parameter
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -400,8 +397,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -434,12 +430,11 @@ Parameters
Choices:
- absent
present ←
- list
Whether to ensure the volume is present or absent.
- The use of state=list to interrogate the volume has been deprecated and will be removed after 2022-06-01. 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.
|
@@ -452,10 +447,11 @@ Parameters
- Default:
{}
|
- tag:value pairs to add to the volume after creation.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -474,7 +470,6 @@ Parameters
Volume throughput in MB/s.
This parameter is only valid for gp3 volumes.
Valid range is from 125 to 1000.
- Requires at least botocore version 1.19.27.
@@ -559,9 +554,9 @@ Notes
-----
.. note::
+ - Support for *purge_tags* was added in release 1.5.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -635,12 +630,6 @@ Examples
instance: None
region: us-west-2
- # List volumes for an instance
- - amazon.aws.ec2_vol:
- instance: i-XXXXXX
- state: list
- region: us-west-2
-
# Create new volume using SSD storage
- amazon.aws.ec2_vol:
instance: XXXXXX
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 e7aeea5d4d9..2018669dcd3 100644
--- a/docs/amazon.aws.ec2_vpc_dhcp_option_info_module.rst
+++ b/docs/amazon.aws.ec2_vpc_dhcp_option_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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -144,6 +140,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
|
@@ -164,6 +161,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
|
@@ -210,8 +208,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -244,8 +241,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -279,7 +275,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -322,12 +317,12 @@ Common return values are documented `here
- | Key |
+ Key |
Returned |
Description |
- |
+ |
changed
@@ -337,17 +332,18 @@ Common return values are documented `here
| always |
- True if listing the dhcp options succeeds
+ True if listing the dhcp options succeeds.
|
|
- |
+ |
dhcp_config
list
+ / elements=dictionary
|
always |
@@ -358,7 +354,7 @@ Common return values are documented `here
| |
-
+ |
domain-name
@@ -368,7 +364,7 @@ Common return values are documented `here
| when available |
- The domain name for hosts in the DHCP option sets
+ The domain name for hosts in the DHCP option sets.
Sample:
['my.example.com']
@@ -376,7 +372,7 @@ Common return values are documented `here
| |
-
+ |
domain-name-servers
@@ -394,7 +390,7 @@ Common return values are documented `here
| |
-
+ |
netbios-name-servers
@@ -412,7 +408,7 @@ Common return values are documented `here
| |
-
+ |
netbios-node-type
@@ -430,7 +426,7 @@ Common return values are documented `here
| |
-
+ |
ntp-servers
@@ -448,7 +444,7 @@ Common return values are documented `here
- |
+ |
dhcp_options
@@ -459,31 +455,87 @@ Common return values are documented `here
| always |
- The DHCP options created, associated or found
+ The DHCP options created, associated or found.
|
|
| |
-
+ |
dhcp_configurations
list
+ / elements=dictionary
|
|
- The DHCP configuration for the option set
+ The DHCP configuration for the option set.
Sample:
['{"key": "ntp-servers", "values": [{"value": "10.0.0.2" , "value": "10.0.1.2"}]}', '{"key": "netbios-name-servers", "values": [{value": "10.0.0.1"}, {"value": "10.0.1.1" }]}']
|
+
+
+ | |
+ |
+
+
+ key
+
+
+ string
+
+ |
+ always |
+
+ The name of a DHCP option.
+
+ |
| |
+ |
+
+
+ values
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of values for the DHCP option.
+
+ |
+
+
+ | |
+ |
+ |
+
+ value
+
+
+ string
+
+ |
+ always |
+
+ The attribute value. This value is case-sensitive.
+
+ |
+
+
+
+
+ | |
+
dhcp_options_id
@@ -493,7 +545,7 @@ Common return values are documented `here
|
- The aws resource id of the primary DCHP options set created or found
+ The aws resource id of the primary DHCP options set created or found.
Sample:
dopt-0955331de6a20dd07
@@ -501,7 +553,7 @@ Common return values are documented `here
| |
-
+ |
owner_id
@@ -519,17 +571,18 @@ Common return values are documented `here
| |
-
+ |
tags
list
+ / elements=dictionary
|
|
- The tags to be applied to a DHCP options set
+ The tags to be applied to a DHCP options set.
Sample:
['{"Key": "CreatedBy", "Value": "ansible-test"}', '{"Key": "Collection", "Value": "amazon.aws"}']
diff --git a/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst b/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst
index 0ee80f8ed9d..52c67a4d1fd 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
| |
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -289,8 +285,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
|
@@ -302,7 +297,6 @@ Parameters
boolean
- added in 2.0.0
|
Choices:
@@ -311,7 +305,9 @@ Parameters
|
- Remove tags not listed in tags.
+ 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.
+
|
@@ -343,8 +339,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -380,7 +375,7 @@ Parameters
|
- Tags to be applied to a VPC options set if a new one is created, or if the resource_id is provided. (options must match)
+ Tags to be applied to a VPC options set if a new one is created, or if dhcp_options_id is provided. (options must match)
aliases: resource_tags
|
@@ -426,9 +421,9 @@ Notes
-----
.. note::
+ - Support for *purge_tags* was added in release 2.0.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst
index 415fe620c51..fc8fc0d43c8 100644
--- a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst
+++ b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_vpc_endpoint_info
********************************
-**Retrieves AWS VPC endpoints details using AWS methods.**
+**Retrieves AWS VPC endpoints details using AWS methods**
Version added: 1.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
| |
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -173,8 +169,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -230,8 +225,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -281,7 +275,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -335,34 +328,36 @@ Common return values are documented `here
- | Key |
+ Key |
Returned |
Description |
- |
+ |
service_names
list
+ / elements=string
|
query is services |
- AWS VPC endpoint service names
+ AWS VPC endpoint service names.
Sample:
{'service_names': ['com.amazonaws.ap-southeast-2.s3']}
|
- |
+ |
vpc_endpoints
list
+ / elements=dictionary
|
query is endpoints |
@@ -373,6 +368,338 @@ Common return values are documented `here {'vpc_endpoints': [{'creation_timestamp': '2017-02-16T11:06:48+00:00', 'policy_document': '"{\\"Version\\":\\"2012-10-17\\",\\"Id\\":\\"Policy1450910922815\\", \\"Statement\\":[{\\"Sid\\":\\"Stmt1450910920641\\",\\"Effect\\":\\"Allow\\", \\"Principal\\":\\"*\\",\\"Action\\":\\"s3:*\\",\\"Resource\\":[\\"arn:aws:s3:::*/*\\",\\"arn:aws:s3:::*\\"]}]}"\n', 'route_table_ids': ['rtb-abcd1234'], 'service_name': 'com.amazonaws.ap-southeast-2.s3', 'state': 'available', 'vpc_endpoint_id': 'vpce-abbad0d0', 'vpc_id': 'vpc-1111ffff'}]}
+
+ | |
+
+
+ creation_timestamp
+
+
+ string
+
+ |
+ always |
+
+ The date and time that the endpoint was created.
+
+ |
+
+
+ | |
+
+
+ dns_entries
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of DNS entires for the endpoint.
+
+ |
+
+
+ | |
+ |
+
+
+ dns_name
+
+
+ string
+
+ |
+ always |
+
+ The DNS name.
+
+ |
+
+
+ | |
+ |
+
+
+ hosted_zone_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the private hosted zone.
+
+ |
+
+
+
+ | |
+
+
+ groups
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of security groups associated with the network interface.
+
+ |
+
+
+ | |
+ |
+
+
+ group_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the security group.
+
+ |
+
+
+ | |
+ |
+
+
+ group_name
+
+
+ string
+
+ |
+ always |
+
+ The name of the security group.
+
+ |
+
+
+
+ | |
+
+
+ network_interface_ids
+
+
+ list
+ / elements=string
+
+ |
+ always |
+
+ List of network interfaces for the endpoint.
+
+ |
+
+
+ | |
+
+
+ owner_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the AWS account that owns the endpoint.
+
+ |
+
+
+ | |
+
+
+ policy_document
+
+
+ string
+
+ |
+ always |
+
+ The policy document associated with the endpoint.
+
+ |
+
+
+ | |
+
+
+ private_dns_enabled
+
+
+ boolean
+
+ |
+ always |
+
+ Indicates whether the VPC is associated with a private hosted zone.
+
+ |
+
+
+ | |
+
+
+ requester_managed
+
+
+ boolean
+
+ |
+ always |
+
+ Indicated whether the endpoint is being managed by its service.
+
+ |
+
+
+ | |
+
+
+ route_table_ids
+
+
+ list
+ / elements=string
+
+ |
+ always |
+
+ List of route table IDs associated with the endpoint.
+
+ |
+
+
+ | |
+
+
+ service_name
+
+
+ string
+
+ |
+ always |
+
+ The name of the service to which the endpoint is associated.
+
+ |
+
+
+ | |
+
+
+ state
+
+
+ string
+
+ |
+ always |
+
+ The state of the endpoint.
+
+ |
+
+
+ | |
+
+
+ subnet_ids
+
+
+ string
+
+ |
+ always |
+
+ List of subnets associated with the endpoint.
+
+ |
+
+
+ | |
+
+
+ tags
+
+
+ list
+ / elements=dictionary
+
+ |
+ always |
+
+ List of tags associated with the endpoint.
+
+ |
+
+
+ | |
+
+
+ vpc_endpoint_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the endpoint.
+
+ |
+
+
+ | |
+
+
+ vpc_endpoint_type
+
+
+ string
+
+ |
+ always |
+
+ The type of endpoint.
+
+ |
+
+
+ | |
+
+
+ vpc_id
+
+
+ string
+
+ |
+ always |
+
+ The ID of the VPC.
+
+ |
+
+
diff --git a/docs/amazon.aws.ec2_vpc_endpoint_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_module.rst
index 2cea1e7f95a..24f6d72b611 100644
--- a/docs/amazon.aws.ec2_vpc_endpoint_module.rst
+++ b/docs/amazon.aws.ec2_vpc_endpoint_module.rst
@@ -28,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -56,8 +56,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -74,7 +73,6 @@ Parameters
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.
|
@@ -92,7 +90,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -108,8 +105,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -209,8 +205,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -222,16 +217,18 @@ Parameters
boolean
- added in 1.5.0
|
- Delete any tags not specified in the task that are on the instance. This means you have to specify all the desired tags on each task affecting an instance.
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -280,8 +277,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -330,13 +326,13 @@ Parameters
dictionary
- added in 1.5.0
|
- A dict of tags to apply to the internet gateway.
- To remove all tags set tags={} and purge_tags=true.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -488,9 +484,9 @@ Notes
-----
.. note::
+ - Support for *tags* and *purge_tags* was added in release 1.5.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
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 835237586e0..532034cc374 100644
--- a/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst
+++ b/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_vpc_endpoint_service_info
****************************************
-**retrieves AWS VPC endpoint service details**
+**Retrieves AWS VPC endpoint service details**
Version added: 1.5.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -174,8 +170,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -208,8 +203,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -259,7 +253,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vpc_igw_info_module.rst b/docs/amazon.aws.ec2_vpc_igw_info_module.rst
index fe7b5d4022b..e78ad730bfa 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -124,12 +120,12 @@ Parameters
Choices:
- no
- - yes
+ yes ←
|
Convert tags from boto3 format (list of dictionaries) to the standard dictionary format.
- This currently defaults to False. The default will be changed to True after 2022-06-22.
+ Prior to release 4.0.0 this defaulted to False.
|
@@ -210,8 +206,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -244,8 +239,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -279,7 +273,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -370,7 +363,7 @@ Common return values are documented `here
state=present |
- Any VPCs attached to the internet gateway
+ Any VPCs attached to the internet gateway.
|
@@ -387,7 +380,7 @@ Common return values are documented `here
state=present |
- The current state of the attachment
+ The current state of the attachment.
Sample:
available
@@ -425,7 +418,7 @@ Common return values are documented `here
state=present |
- The ID of the internet gateway
+ The ID of the internet gateway.
Sample:
igw-2123634d
@@ -443,7 +436,7 @@ Common return values are documented `here
state=present |
- Any tags assigned to the internet gateway
+ Any tags assigned to the internet gateway.
Sample:
{'tags': {'Ansible': 'Test'}}
diff --git a/docs/amazon.aws.ec2_vpc_igw_module.rst b/docs/amazon.aws.ec2_vpc_igw_module.rst
index a24b792f288..0614addbdcf 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -158,8 +154,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -171,7 +166,6 @@ Parameters
boolean
- added in 1.3.0
|
Choices:
@@ -180,7 +174,9 @@ Parameters
|
- Remove tags not listed in tags.
+ 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.
+
|
@@ -212,8 +208,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -249,8 +244,8 @@ Parameters
|
- A dict of tags to apply to the internet gateway.
- To remove all tags set tags={} and purge_tags=true.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -297,9 +292,9 @@ Notes
-----
.. note::
+ - Support for *purge_tags* was added in release 1.3.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
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 7dee973a792..6de10c0d96f 100644
--- a/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst
+++ b/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_vpc_nat_gateway_info
***********************************
-**Retrieves AWS VPC Managed Nat Gateway details using AWS methods.**
+**Retrieves AWS VPC Managed Nat Gateway details using AWS methods**
Version added: 1.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -189,8 +185,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -223,8 +218,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -258,7 +252,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -326,7 +319,7 @@ Common return values are documented `here
always |
- True if listing the internet gateways succeeds
+ True if listing the internet gateways succeeds.
|
@@ -342,7 +335,7 @@ Common return values are documented `here suceess
The result of the describe, converted to ansible snake case style.
-
+
|
@@ -358,7 +351,7 @@ Common return values are documented `here
always |
- The date and time the NAT gateway was created
+ The date and time the NAT gateway was created.
Sample:
2021-03-11T22:43:25+00:00
@@ -376,7 +369,7 @@ Common return values are documented `here
when the NAT gateway has been deleted |
- The date and time the NAT gateway was deleted
+ The date and time the NAT gateway was deleted.
Sample:
2021-03-11T22:43:25+00:00
@@ -394,7 +387,7 @@ Common return values are documented `here
always |
- List containing a dictionary with the IP addresses and network interface associated with the NAT gateway
+ List containing a dictionary with the IP addresses and network interface associated with the NAT gateway.
|
@@ -411,7 +404,7 @@ Common return values are documented `here
always |
- The allocation ID of the Elastic IP address that's associated with the NAT gateway
+ The allocation ID of the Elastic IP address that's associated with the NAT gateway.
Sample:
eipalloc-0853e66a40803da76
@@ -430,7 +423,7 @@ Common return values are documented `here
always |
- The ID of the network interface associated with the NAT gateway
+ The ID of the network interface associated with the NAT gateway.
Sample:
eni-0a37acdbe306c661c
@@ -449,7 +442,7 @@ Common return values are documented `here
always |
- The private IP address associated with the Elastic IP address
+ The private IP address associated with the Elastic IP address.
Sample:
10.0.238.227
@@ -468,7 +461,7 @@ Common return values are documented `here
always |
- The Elastic IP address associated with the NAT gateway
+ The Elastic IP address associated with the NAT gateway.
Sample:
34.204.123.52
@@ -487,7 +480,7 @@ Common return values are documented `here
always |
- The ID of the NAT gateway
+ The ID of the NAT gateway.
Sample:
nat-0c242a2397acf6173
@@ -505,7 +498,7 @@ Common return values are documented `here
always |
- state of the NAT gateway
+ state of the NAT gateway.
Sample:
available
@@ -523,7 +516,7 @@ Common return values are documented `here
always |
- The ID of the subnet in which the NAT gateway is located
+ The ID of the subnet in which the NAT gateway is located.
Sample:
subnet-098c447465d4344f9
@@ -541,7 +534,7 @@ Common return values are documented `here
always |
- Tags applied to the NAT gateway
+ Tags applied to the NAT gateway.
Sample:
{'Tag1': 'tag1', 'Tag_2': 'tag_2'}
@@ -559,7 +552,7 @@ Common return values are documented `here
always |
- The ID of the VPC in which the NAT gateway is located
+ The ID of the VPC in which the NAT gateway is located.
Sample:
vpc-02f37f48438ab7d4c
diff --git a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst
index 1d7d2966ec6..e894ebbd541 100644
--- a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst
+++ b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst
@@ -5,7 +5,7 @@
amazon.aws.ec2_vpc_nat_gateway
******************************
-**Manage AWS VPC NAT Gateways.**
+**Manage AWS VPC NAT Gateways**
Version added: 1.0.0
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -69,8 +69,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -87,7 +86,6 @@ Parameters
|
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.
|
@@ -105,7 +103,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -121,8 +118,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -237,8 +233,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -250,7 +245,6 @@ Parameters
boolean
- added in 1.4.0
|
Choices:
@@ -259,7 +253,9 @@ Parameters
|
- Remove tags not listed in tags.
+ 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.
+
|
@@ -312,8 +308,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -360,13 +355,12 @@ Parameters
dictionary
- added in 1.4.0
|
- A dict of tags to apply to the NAT gateway.
- To remove all tags set tags={} and purge_tags=true.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -432,9 +426,9 @@ Notes
-----
.. note::
+ - Support for *tags* and *purge_tags* was added in release 1.4.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vpc_net_info_module.rst b/docs/amazon.aws.ec2_vpc_net_info_module.rst
index 8105eae509b..6f009d36d79 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -173,8 +169,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -207,8 +202,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -258,7 +252,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -356,7 +349,7 @@ Common return values are documented `here
always |
- The association ID
+ The association ID.
|
@@ -557,7 +550,7 @@ Common return values are documented `here
always |
- The association ID
+ The association ID.
|
@@ -693,7 +686,7 @@ Common return values are documented `here
always |
- The ID of the VPC .
+ The ID of the VPC.
|
diff --git a/docs/amazon.aws.ec2_vpc_net_module.rst b/docs/amazon.aws.ec2_vpc_net_module.rst
index 5c293aaac5c..0b73196beea 100644
--- a/docs/amazon.aws.ec2_vpc_net_module.rst
+++ b/docs/amazon.aws.ec2_vpc_net_module.rst
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -119,13 +115,14 @@ Parameters
list
/ elements=string
- / required
|
|
- The primary CIDR of the VPC. After 2.5 a list of CIDRs can be provided. The first in the list will be used as the primary CIDR and is used in conjunction with the name to ensure idempotence.
+ The primary CIDR of the VPC.
+ The first in the list will be used as the primary CIDR and is used in conjunction with name to ensure idempotence.
+ Required when vpc_id is not set.
|
@@ -174,11 +171,12 @@ Parameters
Choices:
- no
- yes ← - yes
|
Whether to enable AWS hostname support.
+ Default value is true when creating a new VPC.
|
@@ -193,11 +191,12 @@ Parameters
Choices:
- no
- yes ← - yes
|
Whether to enable AWS DNS support.
+ Default value is true when creating a new VPC.
|
@@ -262,13 +261,15 @@ Parameters
string
- / required
|
- The name to give your VPC. This is used in combination with cidr_block to determine if a VPC already exists.
+ The name to give your VPC. This is used in combination with cidr_block to determine if a VPC already exists.
+ The value of name overrides any value set for Name in the tags parameter.
+ At least one of name and vpc_id must be specified.
+ name must be specified when creating a new VPC.
|
@@ -283,8 +284,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -304,7 +304,29 @@ Parameters
|
- Remove CIDRs that are associated with the VPC and are not specified in cidr_block.
+ Remove CIDRs that are associated with the VPC and are not specified in cidr_block.
+ |
+
+
+ |
+
+ purge_tags
+
+
+ boolean
+
+ |
+
+
+ |
+
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -336,8 +358,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -373,7 +394,8 @@ Parameters
|
- The tags you want attached to the VPC. This is independent of the name value, note if you pass a 'Name' key it would override the Name of the VPC if it's different.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -393,7 +415,8 @@ Parameters
|
- Whether to be default or dedicated tenancy. This cannot be changed after the VPC has been created.
+ Whether to be default or dedicated tenancy.
+ This cannot be changed after the VPC has been created.
|
@@ -415,6 +438,24 @@ Parameters
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+ |
+
+ vpc_id
+
+
+ string
+
+ added in 4.0.0
+ |
+
+ |
+
+ The ID of the VPC.
+ At least one of name and vpc_id must be specified.
+ At least one of name and cidr_block must be specified.
+ |
+
@@ -425,7 +466,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -624,6 +664,25 @@ Common return values are documented `here
+
+ | |
+
+
+ name
+
+
+ string
+
+ added in 4.0.0
+ |
+ When the Name tag has been set on the VPC |
+
+ The Name tag of the VPC.
+
+ Sample:
+ MyVPC
+ |
+
| |
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 34b9cc5ab28..d9a9e4e1fc5 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -173,8 +169,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -207,8 +202,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -242,7 +236,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -297,8 +290,8 @@ Common return values are documented `here
always |
- A list of dictionarys describing route tables
-
+ A list of dictionarys describing route tables.
+
|
@@ -314,7 +307,7 @@ Common return values are documented `here
always |
- List of associations between the route table and one or more subnets or a gateway
+ List of associations between the route table and one or more subnets or a gateway.
|
@@ -331,7 +324,7 @@ Common return values are documented `here
always |
- The state of the association
+ The state of the association.
|
@@ -349,7 +342,7 @@ Common return values are documented `here
always |
- The state of the association
+ The state of the association.
Sample:
associated
@@ -369,7 +362,7 @@ Common return values are documented `here
when available |
- Additional information about the state of the association
+ Additional information about the state of the association.
Sample:
Creating association
@@ -389,7 +382,7 @@ Common return values are documented `here
when route table is a gateway route table |
- ID of the internet gateway or virtual private gateway
+ ID of the internet gateway or virtual private gateway.
Sample:
igw-03312309
@@ -408,7 +401,7 @@ Common return values are documented `here
always |
- Whether this is the main route table
+ Whether this is the main route table.
|
@@ -425,7 +418,7 @@ Common return values are documented `here
always |
- ID of association between route table and subnet
+ ID of association between route table and subnet.
Sample:
rtbassoc-ab47cfc3
@@ -444,7 +437,7 @@ Common return values are documented `here
always |
- ID of the route table
+ ID of the route table.
Sample:
rtb-bf779ed7
@@ -463,7 +456,7 @@ Common return values are documented `here
when route table is a subnet route table |
- ID of the subnet
+ ID of the subnet.
Sample:
subnet-82055af9
@@ -482,7 +475,7 @@ Common return values are documented `here
always |
- ID of the route table (same as route_table_id for backwards compatibility)
+ ID of the route table (same as route_table_id for backwards compatibility).
Sample:
rtb-bf779ed7
@@ -500,7 +493,7 @@ Common return values are documented `here
always |
- ID of the account which owns the route table
+ ID of the account which owns the route table.
Sample:
012345678912
@@ -518,7 +511,7 @@ Common return values are documented `here
always |
- List of Virtual Private Gateways propagating routes
+ List of Virtual Private Gateways propagating routes.
|
@@ -534,7 +527,7 @@ Common return values are documented `here
always |
- ID of the route table
+ ID of the route table.
Sample:
rtb-bf779ed7
@@ -552,7 +545,7 @@ Common return values are documented `here
always |
- List of routes in the route table
+ List of routes in the route table.
|
@@ -569,7 +562,7 @@ Common return values are documented `here
always |
- CIDR block of destination
+ CIDR block of destination.
Sample:
10.228.228.0/22
@@ -588,7 +581,7 @@ Common return values are documented `here
when gateway is local or internet gateway |
- ID of the gateway
+ ID of the gateway.
Sample:
local
@@ -608,7 +601,7 @@ Common return values are documented `here always |
ID of a NAT instance.
- Empty unless the route is via an EC2 instance
+ Empty unless the route is via an EC2 instance.
Sample:
i-abcd123456789
@@ -627,8 +620,8 @@ Common return values are documented `here
always |
- AWS account owning the NAT instance
- Empty unless the route is via an EC2 instance
+ AWS account owning the NAT instance.
+ Empty unless the route is via an EC2 instance.
Sample:
123456789012
@@ -645,9 +638,9 @@ Common return values are documented `here string
|
- when the route is via a NAT gateway |
+ when the route is via a NAT gateway. |
- ID of the NAT gateway
+ ID of the NAT gateway.
Sample:
local
@@ -666,8 +659,8 @@ Common return values are documented `here
always |
- The ID of the network interface
- Empty unless the route is via an EC2 instance
+ The ID of the network interface.
+ Empty unless the route is via an EC2 instance.
Sample:
123456789012
@@ -686,7 +679,7 @@ Common return values are documented `here
always |
- mechanism through which the route is in the table
+ mechanism through which the route is in the table.
Sample:
CreateRouteTable
@@ -705,7 +698,7 @@ Common return values are documented `here
always |
- state of the route
+ state of the route.
Sample:
active
@@ -724,7 +717,7 @@ Common return values are documented `here
always |
- Tags applied to the route table
+ Tags applied to the route table.
Sample:
{'Name': 'Public route table', 'Public': 'true'}
@@ -742,7 +735,7 @@ Common return values are documented `here
always |
- ID for the VPC in which the route lives
+ ID for the VPC in which the route lives.
Sample:
vpc-6e2d2407
diff --git a/docs/amazon.aws.ec2_vpc_route_table_module.rst b/docs/amazon.aws.ec2_vpc_route_table_module.rst
index c16786d6a64..3cce5b44288 100644
--- a/docs/amazon.aws.ec2_vpc_route_table_module.rst
+++ b/docs/amazon.aws.ec2_vpc_route_table_module.rst
@@ -26,8 +26,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -179,7 +175,11 @@ Parameters
|
- Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specified then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table you must look up by id.
+ Look up route table by either tags or by route_table_id.
+ If lookup=tag and tags is not specified then no lookup for an existing route table is performed and a new route table will be created.
+ When using lookup=tag, multiple matches being found will result in a failure and no changes will be made.
+ To change the tags of a route table use lookup=id.
+ vpc_id must be specified when lookup=tag.
|
@@ -194,8 +194,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -264,12 +263,15 @@ Parameters
|
|
- Purge existing tags that are not found in route table.
+ 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.
+
+ The current default value of False has been deprecated. The default value will change to True in release 5.0.0.
|
@@ -337,8 +339,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -390,7 +391,8 @@ Parameters
|
- A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }. Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -437,9 +439,9 @@ Notes
-----
.. note::
+ - Tags are used to uniquely identify route tables within a VPC when the *route_table_id* is not supplied.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vpc_subnet_info_module.rst b/docs/amazon.aws.ec2_vpc_subnet_info_module.rst
index 4375c2e4cd5..242deddc2b2 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +54,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +71,6 @@ Parameters
|
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.
|
@@ -90,7 +88,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +103,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -173,8 +169,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -207,8 +202,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -259,7 +253,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.ec2_vpc_subnet_module.rst b/docs/amazon.aws.ec2_vpc_subnet_module.rst
index dba083a233d..7f2eb7cf5f7 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -73,8 +73,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -91,7 +90,6 @@ Parameters
|
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.
|
@@ -109,7 +107,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -125,8 +122,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -231,6 +227,23 @@ Parameters
Specify yes to indicate that instances launched into the subnet should be assigned public IP address by default.
|
+
+ |
+
+ outpost_arn
+
+
+ string
+
+ |
+
+ |
+
+ The Amazon Resource Name (ARN) of the Outpost.
+ If set, allows to create subnet in an Outpost.
+ To specify outpost_arn, availability zone of Outpost subnet must be specified.
+ |
+
|
@@ -243,8 +256,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -264,7 +276,9 @@ Parameters
|
- Whether or not to remove tags that do not appear in the tags list.
+ 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.
+
|
@@ -296,8 +310,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -333,7 +346,8 @@ Parameters
|
- A dict of tags to apply to the subnet. Any tags currently applied to the subnet and not present here will be removed.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
aliases: resource_tags
|
@@ -417,7 +431,6 @@ Notes
.. note::
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.elb_classic_lb_module.rst b/docs/amazon.aws.elb_classic_lb_module.rst
index 320c8927129..c47c3c3026f 100644
--- a/docs/amazon.aws.elb_classic_lb_module.rst
+++ b/docs/amazon.aws.elb_classic_lb_module.rst
@@ -5,7 +5,7 @@
amazon.aws.elb_classic_lb
*************************
-**creates, updates or destroys an Amazon ELB.**
+**Creates, updates or destroys an Amazon ELB**
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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -148,8 +148,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -166,7 +165,6 @@ Parameters
|
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.
|
@@ -184,7 +182,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -200,8 +197,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -597,8 +593,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -668,7 +663,6 @@ Parameters
boolean
- added in 2.1.0
|
Choices:
@@ -677,7 +671,9 @@ Parameters
|
- Whether to remove existing tags that aren't passed in the tags parameter.
+ 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.
+
|
@@ -782,8 +778,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -932,8 +927,9 @@ Parameters
|
- A dictionary of tags to apply to the ELB.
- To delete all tags supply an empty dict ({}) and set purge_tags=true.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -1017,10 +1013,10 @@ 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.
+ - The ec2_elb fact previously set by this module was deprecated in release 2.1.0 and since release 4.0.0 is no longer set.
+ - Support for *purge_tags* was added in release 2.1.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.s3_bucket_module.rst b/docs/amazon.aws.s3_bucket_module.rst
index e5a03a01afa..7fdd95d3055 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.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -77,8 +77,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -95,7 +94,6 @@ Parameters
|
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.
|
@@ -113,7 +111,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -129,8 +126,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -353,8 +349,7 @@ Parameters
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -472,7 +467,9 @@ Parameters
|
- Whether to remove tags that aren't present in the tags parameter.
+ 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.
+
|
@@ -525,6 +522,7 @@ 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
@@ -541,8 +539,7 @@ Parameters
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -578,7 +575,9 @@ Parameters
|
- Tags dict to apply to bucket.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -652,7 +651,6 @@ Notes
- If ``requestPayment``, ``policy``, ``tagging`` or ``versioning`` operations/API aren't implemented by the endpoint, module doesn't fail if each parameter satisfies the following condition. *requester_pays* is ``False``, *policy*, *tags*, and *versioning* are ``None``.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
diff --git a/docs/amazon.aws.aws_s3_module.rst b/docs/amazon.aws.s3_object_module.rst
similarity index 85%
rename from docs/amazon.aws.aws_s3_module.rst
rename to docs/amazon.aws.s3_object_module.rst
index c765533afdf..5caced54bb7 100644
--- a/docs/amazon.aws.aws_s3_module.rst
+++ b/docs/amazon.aws.s3_object_module.rst
@@ -1,11 +1,11 @@
-.. _amazon.aws.aws_s3_module:
+.. _amazon.aws.s3_object_module:
-*****************
-amazon.aws.aws_s3
-*****************
+********************
+amazon.aws.s3_object
+********************
-**manage objects in S3.**
+**Manage objects in S3**
Version added: 1.0.0
@@ -17,7 +17,9 @@ Version added: 1.0.0
Synopsis
--------
-- This module allows the user to manage S3 buckets and the objects within them. Includes support for creating and deleting both objects and buckets, retrieving objects as files or strings, generating download links and copy of an object that is already stored in Amazon S3.
+- This module allows the user to manage the objects and directories within S3 buckets. Includes support for creating and deleting objects and directories, retrieving objects as files or strings, generating download links and copying objects that are already stored in Amazon S3.
+- Support for creating or deleting S3 buckets with this module has been deprecated and will be removed in release 6.0.0.
+- S3 buckets can be created or deleted using the :ref:`amazon.aws.s3_bucket ` module.
@@ -26,8 +28,8 @@ Requirements
The below requirements are needed on the host that executes this module.
- python >= 3.6
-- boto3 >= 1.16.0
-- botocore >= 1.19.0
+- boto3 >= 1.17.0
+- botocore >= 1.20.0
Parameters
@@ -54,8 +56,7 @@ Parameters
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_access_key and profile options are mutually exclusive.
aliases: ec2_access_key, access_key
|
@@ -72,7 +73,6 @@ Parameters
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.
|
@@ -90,7 +90,6 @@ Parameters
A dictionary to modify the botocore configuration.
-
|
@@ -106,8 +105,7 @@ Parameters
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
- If profile is set this parameter is ignored.
- Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The aws_secret_key and profile options are mutually exclusive.
aliases: ec2_secret_key, secret_key
|
@@ -140,9 +138,10 @@ Parameters
|
- The content to PUT into an object.
- The parameter value will be treated as a string and converted to UTF-8 before sending it to S3. To send binary data, use the content_base64 parameter instead.
- Either content, content_base64 or src must be specified for a PUT operation. Ignored otherwise.
+ The content to put into an object.
+ The parameter value will be treated as a string and converted to UTF-8 before sending it to S3.
+ To send binary data, use the content_base64 parameter instead.
+ One of content, content_base64 or src must be specified when mode=put otherwise ignored.
|
@@ -158,9 +157,9 @@ Parameters
|
|
- The base64-encoded binary data to PUT into an object.
+ The base64-encoded binary data to put into an object.
Use this if you need to put raw binary data, and don't forget to encode in base64.
- Either content, content_base64 or src must be specified for a PUT operation. Ignored otherwise.
+ One of content, content_base64 or src must be specified when mode=put otherwise ignored.
|
@@ -177,7 +176,7 @@ Parameters
|
The source details of the object to copy.
- Required if mode is copy.
+ Required if mode=copy.
|
@@ -262,7 +261,8 @@ Parameters
|
|
- The destination file path when downloading an object/key with a GET operation.
+ The destination file path when downloading an object/key when mode=get.
+ Ignored when mode is not get.
|
@@ -316,7 +316,8 @@ Parameters
|
- When set for PUT/COPY mode, asks for server-side encryption.
+ Asks for server-side encryption of the objects when mode=put or mode=copy.
+ Ignored when mode is neither put nor copy.
|
@@ -331,7 +332,8 @@ Parameters
|
|
- KMS key id to use when encrypting objects using encrypting=aws:kms. Ignored if encryption is not aws:kms.
+ KMS key id to use when encrypting objects using encrypting=aws:kms.
+ Ignored if encryption is not aws:kms.
|
@@ -350,7 +352,7 @@ Parameters
|
- What encryption mode to use if encrypt=true.
+ The encryption mode to use if encrypt=true.
|
@@ -367,6 +369,7 @@ Parameters
|
Time limit (in seconds) for the URL generated and returned by S3/Walrus when performing a mode=put or mode=geturl operation.
+ Ignored when mode is neither put nor geturl.
aliases: expiration
|
@@ -382,7 +385,8 @@ Parameters
|
- Custom headers for PUT operation, as a dictionary of key=value and key=value,key=value.
+ Custom headers to use when mode=put as a dictionary of key value pairs.
+ Ignored when mode is not put.
|
@@ -401,7 +405,8 @@ Parameters
|
- Overrides initial bucket lookups in case bucket or iam policies are restrictive. Example: a user may have the GetObject permission but no other permissions. In this case using the option mode: get will fail without specifying ignore_nonexistent_bucket=true.
+ Overrides initial bucket lookups in case bucket or IAM policies are restrictive.
+ This can be useful when a user may have the GetObject permission but no other permissions. In which case using mode=get will fail unless ignore_nonexistent_bucket=true is specified.
|
@@ -432,7 +437,8 @@ Parameters
Default:
1000
- Max number of results to return in list mode, set this if you want to retrieve fewer than the default 1000 keys.
+ Max number of results to return when mode=list, set this if you want to retrieve fewer than the default 1000 keys.
+ Ignored when mode is not list.
|
@@ -447,7 +453,7 @@ Parameters
|
|
- Metadata for PUT/COPY operation, as a dictionary of key=value and key=value,key=value.
+ Metadata to use when mode=put or mode=copy as a dictionary of key value pairs.
|
@@ -475,15 +481,16 @@ Parameters
|
Switches the module behaviour between
- PUT: upload
- GET: download
+ put: upload
+ get: download
geturl: return download URL
getstr: download object as string
list: list keys
- create: create bucket
- delete: delete bucket
+ create: create bucket directories
+ delete: delete bucket directories
delobj: delete object
copy: copy object that is already stored in another bucket
+ Support for creating and deleting buckets has been deprecated and will be removed in release 6.0.0. To create and manage the bucket itself please use the amazon.aws.s3_bucket module.
|
@@ -498,7 +505,8 @@ Parameters
|
|
- Keyname of the object inside the bucket. Can be used to create "virtual directories", see examples.
+ Keyname of the object inside the bucket.
+ Can be used to create "virtual directories", see examples.
|
@@ -511,15 +519,17 @@ Parameters
- Default:
"always"
+ Default:
"different"
|
- Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.
+ Force overwrite either locally on the filesystem or remotely with the object/key.
+ Used when mode=put or mode=get.
+ Ignored when when mode is neither put nor get.
Must be a Boolean, always, never, different or latest.
true is the same as always.
false is equal to never.
-
- (GET mode only) When this is set to latest the last modified timestamp of local file is compared with the 'LastModified' of the object/key in S3.
+
+ When mode=get and overwrite=latest the last modified timestamp of local file is compared with the 'LastModified' of the object/key in S3.
aliases: force
|
@@ -537,7 +547,8 @@ Parameters
Default:
["private"]
- This option lets the user set the canned permissions on the object/bucket that are created. The permissions that can be set are private, public-read, public-read-write, authenticated-read for a bucket or private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control for an object. Multiple permissions can be specified as a list; although only the first one will be used during the initial upload of the file
+ This option lets the user set the canned permissions on the object/bucket that are created. The permissions that can be set are private, public-read, public-read-write, authenticated-read for a bucket or private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control for an object. Multiple permissions can be specified as a list; although only the first one will be used during the initial upload of the file.
+
|
@@ -568,8 +579,7 @@ Parameters
|
|
- Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
- aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
aliases: aws_profile
|
@@ -581,7 +591,6 @@ Parameters
boolean
- added in 2.0.0
Choices:
@@ -590,8 +599,9 @@ Parameters
|
- Whether or not to remove tags assigned to the S3 object if not specified in the playbook.
- To remove all tags set tags to an empty dictionary in conjunction with this.
+ 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.
+
|
@@ -659,6 +669,7 @@ 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
|
@@ -675,8 +686,7 @@ Parameters
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
- If profile is set this parameter is ignored.
- Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+ The security_token and profile options are mutually exclusive.
Aliases aws_session_token and session_token have been added in version 3.2.0.
aliases: aws_session_token, session_token, aws_security_token, access_token
|
@@ -693,8 +703,8 @@ Parameters
|
- The source file path when performing a PUT operation.
- Either content, content_base64 or src must be specified for a PUT operation. Ignored otherwise.
+ The source file path when performing a put operation.
+ One of content, content_base64 or src must be specified when mode=put otherwise ignored.
|
@@ -705,12 +715,13 @@ Parameters
dictionary
- added in 2.0.0
|
- Tags dict to apply to the S3 object.
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+
aliases: resource_tags
|
@@ -732,7 +743,7 @@ Parameters
|
Whether the bucket name should be validated to conform to AWS S3 naming rules.
On by default, this may be disabled for S3 backends that do not enforce these rules.
- See https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
+
|
@@ -777,9 +788,9 @@ Notes
-----
.. note::
+ - Support for *tags* and *purge_tags* was added in release 2.0.0.
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
- When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
- - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
- ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -790,21 +801,21 @@ Examples
.. code-block:: yaml
- name: Simple PUT operation
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
src: /usr/local/myfile.txt
mode: put
- name: PUT operation from a rendered template
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /object.yaml
content: "{{ lookup('template', 'templates/object.yaml.j2') }}"
mode: put
- name: Simple PUT operation in Ceph RGW S3
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
src: /usr/local/myfile.txt
@@ -813,14 +824,14 @@ Examples
s3_url: "http://localhost:8000"
- name: Simple GET operation
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
dest: /usr/local/myfile.txt
mode: get
- name: Get a specific version of an object.
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
version: 48c9ee5131af7a716edc22df9772aa6f
@@ -828,7 +839,7 @@ Examples
mode: get
- name: PUT/upload with metadata
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
src: /usr/local/myfile.txt
@@ -836,7 +847,7 @@ Examples
metadata: 'Content-Encoding=gzip,Cache-Control=no-cache'
- name: PUT/upload with custom headers
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
src: /usr/local/myfile.txt
@@ -844,12 +855,12 @@ Examples
headers: 'x-amz-grant-full-control=emailAddress=owner@example.com'
- name: List keys simple
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
mode: list
- name: List keys all options
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
mode: list
prefix: /my/desired/
@@ -857,25 +868,25 @@ Examples
max_keys: 472
- name: Create an empty bucket
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
mode: create
permission: public-read
- name: Create a bucket with key as directory, in the EU region
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/directory/path
mode: create
region: eu-west-1
- name: Delete a bucket and all contents
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
mode: delete
- name: GET an object but don't download if the file checksums match. New in 2.0
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
dest: /usr/local/myfile.txt
@@ -883,13 +894,13 @@ Examples
overwrite: different
- name: Delete an object from a bucket
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
mode: delobj
- name: Copy an object already stored in another bucket
- amazon.aws.aws_s3:
+ amazon.aws.s3_object:
bucket: mybucket
object: /my/desired/key.txt
mode: copy
@@ -1010,4 +1021,4 @@ Authors
- Lester Wade (@lwade)
- Sloane Hertel (@s-hertel)
-- Alina Buzachis (@linabuzachis)
+- Alina Buzachis (@alinabuzachis)
diff --git a/galaxy.yml b/galaxy.yml
index ea183018618..c425ec0f10e 100644
--- a/galaxy.yml
+++ b/galaxy.yml
@@ -1,6 +1,6 @@
namespace: amazon
name: aws
-version: 4.0.0-dev0
+version: 4.0.0
readme: README.md
authors:
- Ansible (https://github.com/ansible)
diff --git a/meta/runtime.yml b/meta/runtime.yml
index 4844c1eceaa..092113c3873 100644
--- a/meta/runtime.yml
+++ b/meta/runtime.yml
@@ -7,9 +7,6 @@ action_groups:
- aws_secret
- cloudformation
- cloudformation_info
- - ec2
- - ec2
- - ec2
- ec2_ami
- ec2_ami_info
- ec2_elb_lb
@@ -61,13 +58,6 @@ plugin_routing:
Please update your tasks.
aws_s3:
redirect: amazon.aws.s3_object
- ec2:
- deprecation:
- removal_version: 4.0.0
- warning_text: >-
- The ec2 module is based upon a deprecated version of the AWS SDKs
- and is deprecated in favor of the ec2_instance module.
- Please update your tasks.
ec2_elb_lb:
redirect: amazon.aws.elb_classic_lb
ec2_eni_facts: