diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 357ae09c8cb..2607567a0ab 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,37 @@ community.aws Release Notes .. contents:: Topics +v3.1.0 +====== + +Minor Changes +------------- + +- add new parameters hostvars_prefix and hostvars_suffix for inventory plugins aws_ec2 and aws_rds (https://github.com/ansible-collections/amazon.aws/issues/535). +- aws_s3 - Add ``validate_bucket_name`` option, to control bucket name validation (https://github.com/ansible-collections/amazon.aws/pull/615). +- aws_s3 - add latest choice on ``overwrite`` parameter to get latest object on S3 (https://github.com/ansible-collections/amazon.aws/pull/595). +- ec2_vol - add support for OutpostArn param (https://github.com/ansible-collections/amazon.aws/pull/597). +- ec2_vol - tag volume on creation (https://github.com/ansible-collections/amazon.aws/pull/603). +- ec2_vpc_route_table - add support for IPv6 in creating route tables (https://github.com/ansible-collections/amazon.aws/pull/601). +- s3_bucket - Add ``validate_bucket_name`` option, to control bucket name validation (https://github.com/ansible-collections/amazon.aws/pull/615). + +Deprecated Features +------------------- + +- ec2_instance - The default value for ```instance_type``` has been deprecated, in the future release you must set an instance_type or a launch_template (https://github.com/ansible-collections/amazon.aws/pull/587). + +Bugfixes +-------- + +- Various modules and plugins - use vendored version of ``distutils.version`` instead of the deprecated Python standard library ``distutils`` (https://github.com/ansible-collections/amazon.aws/pull/599). +- aws_acm - No longer raising ResourceNotFound exception while retrieving ACM certificates. +- aws_s3 - fix exception raised when using module to copy from source to destination and key is missing from source (https://github.com/ansible-collections/amazon.aws/issues/602). +- ec2_instance - Add a condition to handle default ```instance_type``` value for fix breaking on instance creation with launch template (https://github.com/ansible-collections/amazon.aws/pull/587). +- ec2_key - add support for ED25519 key type (https://github.com/ansible-collections/amazon.aws/issues/572). +- ec2_vol - Sets the Iops value in req_obj even if the iops value has not changed, to allow modifying volume types that require passing an iops value to boto. (https://github.com/ansible-collections/amazon.aws/pull/606) +- elb_classic_lb - handle security_group_ids when providing security_group_names and fix broken tasks in integration test (https://github.com/ansible-collections/amazon.aws/pull/592). +- s3_bucket - Enable the management of bucket-level ACLs (https://github.com/ansible-collections/amazon.aws/issues/573). + v3.0.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 3821a918262..b3e14e42205 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -649,3 +649,52 @@ releases: - 575-deprecate-boto.yml - remove_deprecated_facts.yml release_date: '2021-12-06' + 3.1.0: + changes: + bugfixes: + - Various modules and plugins - use vendored version of ``distutils.version`` + instead of the deprecated Python standard library ``distutils`` (https://github.com/ansible-collections/amazon.aws/pull/599). + - aws_acm - No longer raising ResourceNotFound exception while retrieving ACM + certificates. + - aws_s3 - fix exception raised when using module to copy from source to destination + and key is missing from source (https://github.com/ansible-collections/amazon.aws/issues/602). + - ec2_instance - Add a condition to handle default ```instance_type``` value + for fix breaking on instance creation with launch template (https://github.com/ansible-collections/amazon.aws/pull/587). + - ec2_key - add support for ED25519 key type (https://github.com/ansible-collections/amazon.aws/issues/572). + - ec2_vol - Sets the Iops value in req_obj even if the iops value has not changed, + to allow modifying volume types that require passing an iops value to boto. + (https://github.com/ansible-collections/amazon.aws/pull/606) + - elb_classic_lb - handle security_group_ids when providing security_group_names + and fix broken tasks in integration test (https://github.com/ansible-collections/amazon.aws/pull/592). + - s3_bucket - Enable the management of bucket-level ACLs (https://github.com/ansible-collections/amazon.aws/issues/573). + deprecated_features: + - ec2_instance - The default value for ```instance_type``` has been deprecated, + in the future release you must set an instance_type or a launch_template (https://github.com/ansible-collections/amazon.aws/pull/587). + minor_changes: + - add new parameters hostvars_prefix and hostvars_suffix for inventory plugins + aws_ec2 and aws_rds (https://github.com/ansible-collections/amazon.aws/issues/535). + - aws_s3 - Add ``validate_bucket_name`` option, to control bucket name validation + (https://github.com/ansible-collections/amazon.aws/pull/615). + - aws_s3 - add latest choice on ``overwrite`` parameter to get latest object + on S3 (https://github.com/ansible-collections/amazon.aws/pull/595). + - ec2_vol - add support for OutpostArn param (https://github.com/ansible-collections/amazon.aws/pull/597). + - ec2_vol - tag volume on creation (https://github.com/ansible-collections/amazon.aws/pull/603). + - ec2_vpc_route_table - add support for IPv6 in creating route tables (https://github.com/ansible-collections/amazon.aws/pull/601). + - s3_bucket - Add ``validate_bucket_name`` option, to control bucket name validation + (https://github.com/ansible-collections/amazon.aws/pull/615). + fragments: + - 587-ec2_instance-default-instance-type-launch-template.yml + - 592-elb_classic_lb-handle-sg-ids-fix-tests.yml + - 593-aws_s3-fix-copy-when-missing-key.yml + - 595-aws_s3-add-latest-choice-on-overwrite-parameter.yml + - 597-ec2_vol-add-outpostarn-support.yml + - 601-ec2_vpc_route_table-ipv6-support.yml + - 603-ec2_vol-add-tags-on-creation.yml + - 606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml + - 611-s3_bucket-add-support-for-acl.yml + - 614-ec2_key-add-support-for-ed25519-key-type.yml + - 615-s3-validate_bucket_name.yml + - 619-aws_ec2-aws_rds-add-support-for-hostvars_prefix-and-hostvars_suffix.yml + - 646-acm-resource-not-found.yml + - disutils.version.yml + release_date: '2022-02-10' diff --git a/changelogs/fragments/592-elb_classic_lb-handle-sg-ids-fix-tests.yml b/changelogs/fragments/592-elb_classic_lb-handle-sg-ids-fix-tests.yml deleted file mode 100644 index 55229b1e6e3..00000000000 --- a/changelogs/fragments/592-elb_classic_lb-handle-sg-ids-fix-tests.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- elb_classic_lb - handle security_group_ids when providing security_group_names and fix broken tasks in integration test (https://github.com/ansible-collections/amazon.aws/pull/592). diff --git a/changelogs/fragments/593-aws_s3-fix-copy-when-missing-key.yml b/changelogs/fragments/593-aws_s3-fix-copy-when-missing-key.yml deleted file mode 100644 index bc22d6ef934..00000000000 --- a/changelogs/fragments/593-aws_s3-fix-copy-when-missing-key.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- aws_s3 - fix exception raised when using module to copy from source to destination and key is missing from source (https://github.com/ansible-collections/amazon.aws/issues/602). diff --git a/changelogs/fragments/595-aws_s3-add-latest-choice-on-overwrite-parameter.yml b/changelogs/fragments/595-aws_s3-add-latest-choice-on-overwrite-parameter.yml deleted file mode 100644 index 74b96e93e24..00000000000 --- a/changelogs/fragments/595-aws_s3-add-latest-choice-on-overwrite-parameter.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- aws_s3 - add latest choice on ``overwrite`` parameter to get latest object on S3 (https://github.com/ansible-collections/amazon.aws/pull/595). diff --git a/changelogs/fragments/597-ec2_vol-add-outpostarn-support.yml b/changelogs/fragments/597-ec2_vol-add-outpostarn-support.yml deleted file mode 100644 index 26daff8b700..00000000000 --- a/changelogs/fragments/597-ec2_vol-add-outpostarn-support.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ec2_vol - add support for OutpostArn param (https://github.com/ansible-collections/amazon.aws/pull/597). diff --git a/changelogs/fragments/601-ec2_vpc_route_table-ipv6-support.yml b/changelogs/fragments/601-ec2_vpc_route_table-ipv6-support.yml deleted file mode 100644 index 59a286c7041..00000000000 --- a/changelogs/fragments/601-ec2_vpc_route_table-ipv6-support.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_vpc_route_table - add support for IPv6 in creating route tables (https://github.com/ansible-collections/amazon.aws/pull/601). diff --git a/changelogs/fragments/603-ec2_vol-add-tags-on-creation.yml b/changelogs/fragments/603-ec2_vol-add-tags-on-creation.yml deleted file mode 100644 index 256616a8bbc..00000000000 --- a/changelogs/fragments/603-ec2_vol-add-tags-on-creation.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ec2_vol - tag volume on creation (https://github.com/ansible-collections/amazon.aws/pull/603). \ No newline at end of file diff --git a/changelogs/fragments/606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml b/changelogs/fragments/606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml deleted file mode 100644 index c3c1580d463..00000000000 --- a/changelogs/fragments/606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml +++ /dev/null @@ -1,5 +0,0 @@ -bugfixes: -- >- - ec2_vol - Sets the Iops value in req_obj even if the iops value - has not changed, to allow modifying volume types that require - passing an iops value to boto. (https://github.com/ansible-collections/amazon.aws/pull/606) diff --git a/changelogs/fragments/611-s3_bucket-add-support-for-acl.yml b/changelogs/fragments/611-s3_bucket-add-support-for-acl.yml deleted file mode 100644 index b976d42ff5d..00000000000 --- a/changelogs/fragments/611-s3_bucket-add-support-for-acl.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- s3_bucket - Enable the management of bucket-level ACLs (https://github.com/ansible-collections/amazon.aws/issues/573). diff --git a/changelogs/fragments/614-ec2_key-add-support-for-ed25519-key-type.yml b/changelogs/fragments/614-ec2_key-add-support-for-ed25519-key-type.yml deleted file mode 100644 index d7a89e5293e..00000000000 --- a/changelogs/fragments/614-ec2_key-add-support-for-ed25519-key-type.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_key - add support for ED25519 key type (https://github.com/ansible-collections/amazon.aws/issues/572). diff --git a/changelogs/fragments/619-aws_ec2-aws_rds-add-support-for-hostvars_prefix-and-hostvars_suffix.yml b/changelogs/fragments/619-aws_ec2-aws_rds-add-support-for-hostvars_prefix-and-hostvars_suffix.yml deleted file mode 100644 index 7623f1d456c..00000000000 --- a/changelogs/fragments/619-aws_ec2-aws_rds-add-support-for-hostvars_prefix-and-hostvars_suffix.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- add new parameters hostvars_prefix and hostvars_suffix for inventory plugins aws_ec2 and aws_rds (https://github.com/ansible-collections/amazon.aws/issues/535). diff --git a/changelogs/fragments/646-acm-resource-not-found.yml b/changelogs/fragments/646-acm-resource-not-found.yml deleted file mode 100644 index 4bef9adbfa8..00000000000 --- a/changelogs/fragments/646-acm-resource-not-found.yml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: -- >- - aws_acm - No longer raising ResourceNotFound exception while retrieving ACM certificates. diff --git a/changelogs/fragments/disutils.version.yml b/changelogs/fragments/disutils.version.yml deleted file mode 100644 index 6c1b083036a..00000000000 --- a/changelogs/fragments/disutils.version.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - "Various modules and plugins - use vendored version of ``distutils.version`` instead of the deprecated Python standard library ``distutils`` (https://github.com/ansible-collections/amazon.aws/pull/599)." diff --git a/docs/amazon.aws.aws_az_info_module.rst b/docs/amazon.aws.aws_az_info_module.rst index 451c3e15bcb..6b1c406f38b 100644 --- a/docs/amazon.aws.aws_az_info_module.rst +++ b/docs/amazon.aws.aws_az_info_module.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.aws_caller_info_module.rst b/docs/amazon.aws.aws_caller_info_module.rst index 97ab67ee764..a6adcdd108d 100644 --- a/docs/amazon.aws.aws_caller_info_module.rst +++ b/docs/amazon.aws.aws_caller_info_module.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.aws_ec2_inventory.rst b/docs/amazon.aws.aws_ec2_inventory.rst index 2bad8efa243..eee199af4b8 100644 --- a/docs/amazon.aws.aws_ec2_inventory.rst +++ b/docs/amazon.aws.aws_ec2_inventory.rst @@ -17,7 +17,7 @@ amazon.aws.aws_ec2 Synopsis -------- - Get inventory hosts from Amazon Web Services EC2. -- Uses a YAML configuration file that ends with ``aws_ec2.(yml|yaml``). +- Uses a YAML configuration file that ends with ``aws_ec2.{yml|yaml}``. @@ -339,6 +339,42 @@ Parameters
To use tags as hostnames use the syntax tag:Name=Value to use the hostname Name_Value, or tag:Name to use the value of the Name tag.
+ + +
+ hostvars_prefix + +
+ string +
+
added in 3.1.0
+ + + + + + +
The prefix for host variables names coming from AWS.
+ + + + +
+ hostvars_suffix + +
+ string +
+
added in 3.1.0
+ + + + + + +
The suffix for host variables names coming from AWS.
+ +
@@ -716,6 +752,12 @@ Examples ansible_host: public_dns_name groups: libvpc: vpc_id == 'vpc-####' + # Define prefix and suffix for host variables coming from AWS. + plugin: aws_ec2 + regions: + - us-east-1 + hostvars_prefix: 'aws_' + hostvars_suffix: '_ec2' diff --git a/docs/amazon.aws.aws_rds_inventory.rst b/docs/amazon.aws.aws_rds_inventory.rst index de00b859f0c..eaa986de618 100644 --- a/docs/amazon.aws.aws_rds_inventory.rst +++ b/docs/amazon.aws.aws_rds_inventory.rst @@ -297,6 +297,42 @@ Parameters
Add hosts to group based on Jinja2 conditionals.
+ + +
+ hostvars_prefix + +
+ string +
+
added in 3.1.0
+ + + + + + +
The prefix for host variables names coming from AWS.
+ + + + +
+ hostvars_suffix + +
+ string +
+
added in 3.1.0
+ + + + + + +
The suffix for host variables names coming from AWS.
+ +
@@ -504,6 +540,8 @@ Examples prefix: rds - key: tags - key: region + hostvars_prefix: aws_ + hostvars_suffix: _rds diff --git a/docs/amazon.aws.aws_s3_module.rst b/docs/amazon.aws.aws_s3_module.rst index 2ec80a8df56..1ae8cf61909 100644 --- a/docs/amazon.aws.aws_s3_module.rst +++ b/docs/amazon.aws.aws_s3_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -515,10 +515,11 @@ Parameters
Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.
-
Must be a Boolean, always, never or different.
+
Must be a Boolean, always, never, different or latest.
true is the same as always.
false is equal to never.
When this is set to different the MD5 sum of the local file is compared with the 'ETag' of the object/key in S3. The ETag may or may not be an MD5 digest of the object data. See the ETag response header here https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html.
+
(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.

aliases: force
@@ -711,6 +712,28 @@ Parameters
Tags dict to apply to the S3 object.
+ + +
+ validate_bucket_name + +
+ boolean +
+
added in 3.1.0
+ + + + + +
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
+ +
diff --git a/docs/amazon.aws.cloudformation_info_module.rst b/docs/amazon.aws.cloudformation_info_module.rst index c66032b8b16..f125ee68921 100644 --- a/docs/amazon.aws.cloudformation_info_module.rst +++ b/docs/amazon.aws.cloudformation_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.cloudformation_module.rst b/docs/amazon.aws.cloudformation_module.rst index 071c5db025c..94a4c121acb 100644 --- a/docs/amazon.aws.cloudformation_module.rst +++ b/docs/amazon.aws.cloudformation_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_ami_info_module.rst b/docs/amazon.aws.ec2_ami_info_module.rst index 6117f413450..665f62ad2ce 100644 --- a/docs/amazon.aws.ec2_ami_info_module.rst +++ b/docs/amazon.aws.ec2_ami_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_ami_module.rst b/docs/amazon.aws.ec2_ami_module.rst index 8bd0fb52d9c..fc938c2c955 100644 --- a/docs/amazon.aws.ec2_ami_module.rst +++ b/docs/amazon.aws.ec2_ami_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_eni_info_module.rst b/docs/amazon.aws.ec2_eni_info_module.rst index 6937323de2c..cde7a682aca 100644 --- a/docs/amazon.aws.ec2_eni_info_module.rst +++ b/docs/amazon.aws.ec2_eni_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_eni_module.rst b/docs/amazon.aws.ec2_eni_module.rst index 642885490cd..5ee3f3724f8 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_group_info_module.rst b/docs/amazon.aws.ec2_group_info_module.rst index 67fdf982594..9b8b0660c3b 100644 --- a/docs/amazon.aws.ec2_group_info_module.rst +++ b/docs/amazon.aws.ec2_group_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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_group_module.rst b/docs/amazon.aws.ec2_group_module.rst index 94c6edd5791..f82160bb8a4 100644 --- a/docs/amazon.aws.ec2_group_module.rst +++ b/docs/amazon.aws.ec2_group_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_instance_info_module.rst b/docs/amazon.aws.ec2_instance_info_module.rst index d7d864e546d..ffb26af2a79 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_instance_module.rst b/docs/amazon.aws.ec2_instance_module.rst index 3fcc821359b..98fb0c39677 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -472,10 +472,10 @@ Parameters - Default:
"t2.micro"
Instance type to use for the instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html Only required when instance is not already present.
+
If not specified, t2.micro will be used.
@@ -1353,10 +1353,10 @@ Examples image_id: ami-123456 exact_count: 5 region: us-east-2 + vpc_subnet_id: subnet-0123456 network: assign_public_ip: yes security_group: default - vpc_subnet_id: subnet-0123456 tags: foo: bar diff --git a/docs/amazon.aws.ec2_key_module.rst b/docs/amazon.aws.ec2_key_module.rst index 1f5e5ba91c4..5fb1f96a4d6 100644 --- a/docs/amazon.aws.ec2_key_module.rst +++ b/docs/amazon.aws.ec2_key_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -180,6 +180,30 @@ Parameters
Public key material.
+ + +
+ key_type + +
+ string +
+
added in 3.1.0
+ + + + + +
The type of key pair to create.
+
Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.
+
By default Amazon will create an RSA key.
+
Mutually exclusive with parameter key_material.
+
Requires at least botocore version 1.21.23.
+ +
@@ -391,6 +415,11 @@ Examples name: my_keypair key_material: "{{ lookup('file', '/path/to/public_key/id_rsa.pub') }}" + - name: Create ED25519 key pair + amazon.aws.ec2_key: + name: my_keypair + key_type: ed25519 + # try creating a key pair with the name of an already existing keypair # but don't overwrite it even if the key is different (force=false) - name: try creating a key pair with name of an already existing keypair @@ -540,6 +569,25 @@ Common return values are documented `here {"my_key": "my value"} + +   + +
+ type + +
+ string +
+
added in 3.1.0
+ + when a new keypair is created by AWS + +
type of a newly created keypair
+
+
Sample:
+
rsa
+ + diff --git a/docs/amazon.aws.ec2_module.rst b/docs/amazon.aws.ec2_module.rst index c356a876691..0432b9cfca4 100644 --- a/docs/amazon.aws.ec2_module.rst +++ b/docs/amazon.aws.ec2_module.rst @@ -35,8 +35,8 @@ Requirements The below requirements are needed on the host that executes this module. - boto -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 - python >= 2.6 - python >= 3.6 diff --git a/docs/amazon.aws.ec2_snapshot_info_module.rst b/docs/amazon.aws.ec2_snapshot_info_module.rst index b6e0f9f963a..5a628f380bc 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_snapshot_module.rst b/docs/amazon.aws.ec2_snapshot_module.rst index 63118af5d47..8fde49da29f 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_spot_instance_info_module.rst b/docs/amazon.aws.ec2_spot_instance_info_module.rst index fb04028b21e..9ced311483e 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_spot_instance_module.rst b/docs/amazon.aws.ec2_spot_instance_module.rst index 2b39a25bf91..cf2ee2b6b0e 100644 --- a/docs/amazon.aws.ec2_spot_instance_module.rst +++ b/docs/amazon.aws.ec2_spot_instance_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_tag_info_module.rst b/docs/amazon.aws.ec2_tag_info_module.rst index 6e316e108f5..7360fb05f89 100644 --- a/docs/amazon.aws.ec2_tag_info_module.rst +++ b/docs/amazon.aws.ec2_tag_info_module.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_tag_module.rst b/docs/amazon.aws.ec2_tag_module.rst index 97b5395ab97..fe6bdc755e8 100644 --- a/docs/amazon.aws.ec2_tag_module.rst +++ b/docs/amazon.aws.ec2_tag_module.rst @@ -28,8 +28,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vol_info_module.rst b/docs/amazon.aws.ec2_vol_info_module.rst index e1c2a6adf24..3f989c8f8e3 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst index 5ab132d875b..c16e844fd33 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -317,6 +317,23 @@ Parameters
Volume Name tag if you wish to attach an existing volume (requires instance)
+ + +
+ outpost_arn + +
+ string +
+
added in 3.1.0
+ + + + +
The Amazon Resource Name (ARN) of the Outpost.
+
If set, allows to create volume in an Outpost.
+ +
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 ca62927107b..f27dac283a8 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst b/docs/amazon.aws.ec2_vpc_dhcp_option_module.rst index 2a658b7747f..dab031e1595 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst index b357e740b4c..6d16b46d09b 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_endpoint_module.rst b/docs/amazon.aws.ec2_vpc_endpoint_module.rst index 60e1d25169e..c4a375c97de 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -264,6 +264,7 @@ Parameters
List of one or more route table ids to attach to the endpoint. A route is added to the route table with the destination of the endpoint if provided.
+
Route table ids are only valid for gateway type endpoints.
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 0991b923b74..2c9438a65f9 100644 --- a/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_endpoint_service_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_igw_info_module.rst b/docs/amazon.aws.ec2_vpc_igw_info_module.rst index c4b1522c618..ce612b4d8d6 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_igw_module.rst b/docs/amazon.aws.ec2_vpc_igw_module.rst index 3ffff8b0ecb..6cd4325e203 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst b/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst index 99778426974..23962bd9b12 100644 --- a/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst +++ b/docs/amazon.aws.ec2_vpc_nat_gateway_info_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst index 345e65ef907..08e9b8fd391 100644 --- a/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst +++ b/docs/amazon.aws.ec2_vpc_nat_gateway_module.rst @@ -26,8 +26,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_net_info_module.rst b/docs/amazon.aws.ec2_vpc_net_info_module.rst index 489ca214905..2dbc03efce0 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_net_module.rst b/docs/amazon.aws.ec2_vpc_net_module.rst index 587afee08fa..aaa846b928d 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters 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 8c540fc4e99..9901acc80d9 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_route_table_module.rst b/docs/amazon.aws.ec2_vpc_route_table_module.rst index bda65997981..21be28e429a 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_subnet_info_module.rst b/docs/amazon.aws.ec2_vpc_subnet_info_module.rst index 3093057abb6..c2ee6d57b8d 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.ec2_vpc_subnet_module.rst b/docs/amazon.aws.ec2_vpc_subnet_module.rst index b8354e2f76b..b6ee3a5942f 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.elb_classic_lb_module.rst b/docs/amazon.aws.elb_classic_lb_module.rst index 32176e2d370..eb6f1680e09 100644 --- a/docs/amazon.aws.elb_classic_lb_module.rst +++ b/docs/amazon.aws.elb_classic_lb_module.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - python >= 3.6 -- boto3 >= 1.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters diff --git a/docs/amazon.aws.s3_bucket_module.rst b/docs/amazon.aws.s3_bucket_module.rst index 3369010d8fa..46f13e701bd 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.15.0 -- botocore >= 1.18.0 +- boto3 >= 1.16.0 +- botocore >= 1.19.0 Parameters @@ -41,6 +41,29 @@ Parameters Choices/Defaults Comments + + +
+ acl + +
+ string +
+
added in 3.1.0
+ + + + + +
The canned ACL to apply to the bucket.
+
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.
+ +
@@ -554,6 +577,28 @@ Parameters
Tags dict to apply to bucket.
+ + +
+ validate_bucket_name + +
+ boolean +
+
added in 3.1.0
+ + + + + +
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
+ +
@@ -701,6 +746,12 @@ Examples state: present policy: "null" + # This example grants public-read to everyone on bucket using ACL + - amazon.aws.s3_bucket: + name: mys3bucket + state: present + acl: public-read + Return Values @@ -715,6 +766,23 @@ Common return values are documented `here Returned Description + + +
+ acl + +
+ dictionary +
+ + state=present + +
S3 bucket's canned ACL.
+
+
Sample:
+
public-read
+ +