From bf3a4c6818223d68c3961dbd242f992c872e0b9d Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Sat, 13 Nov 2021 07:31:49 +0100 Subject: [PATCH] Prepare for community.aws release 2.1.0 (#803) Prepare for community.aws release 2.1.0 SUMMARY It is time. ISSUE TYPE Feature Pull Request COMPONENT NAME whole collection ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz Reviewed-by: None --- CHANGELOG.rst | 89 ++ README.md | 12 +- changelogs/changelog.yaml | 156 ++ changelogs/fragments/0-copy_ignore_txt.yml | 3 - .../228-ecs_service-force_delete.yml | 2 - changelogs/fragments/332-ec2_eip-tagging.yml | 4 - changelogs/fragments/375-lambda_info-tags.yml | 2 - .../384-elb_instance-python3-fixups.yml | 2 - .../fragments/522-efs-IA-transition.yml | 2 - .../557-action_group-missing-entry.yml | 2 - changelogs/fragments/565-route53-tagging.yml | 2 - .../fragments/595-fix-route53-identifer.yaml | 2 - .../670-elb_target_group-new_attriibutes.yml | 3 - .../693-elb_classic_lb_info-without-names.yml | 2 - ...d-cloudfront-new-security-policy-2021.yaml | 2 - .../724-redshift_subnet_group-boto3.yml | 7 - .../fragments/726-dynamodb_table-boto3.yml | 5 - changelogs/fragments/728-iam_cert.yml | 3 - .../fragments/731-ec2_eip-not_in_vpc.yml | 2 - .../fragments/734-route53_health_check.yml | 3 - .../735-iam_server_certificate-file-names.yml | 3 - .../737-iam_server_certificate-boto3.yml | 7 - .../739-sns_topic-delivery_policy-shape.yml | 2 - .../741-ecs_taskdefinition-placement.yml | 2 - .../747-rds-enhanced-monitoring-bug-fix.yml | 2 - .../748-iam_role_info-jittered-backoff.yaml | 2 - .../fragments/753-dynamodb-billing_mode.yml | 2 - .../756-route53_health_check-disable.yml | 2 - changelogs/fragments/759-ec2_win_password.yml | 2 - .../762-fix-kmsmasterkeyid-attr.yaml | 2 - changelogs/fragments/764-awsretry-backoff.yml | 18 - .../765-route53_health_check-tags.yml | 2 - .../767-iam_role-add-waiter-support.yml | 2 - .../fragments/773-elb_instance-boto3.yml | 7 - .../fragments/774-add-aws_kms_parameters.yml | 2 - .../fragments/777-lambda_info-awsretry.yml | 3 - .../780-fix-cloudfront_info-pagination.yml | 2 - changelogs/fragments/783-rds_snapshot.yml | 3 - .../798-fix-route53-empty-result.yaml | 2 - changelogs/fragments/802-fix-diif-mode.yml | 2 - docs/community.aws.aws_api_gateway_module.rst | 1 - docs/community.aws.aws_kms_module.rst | 59 +- docs/community.aws.cloudfront_info_module.rst | 2 +- docs/community.aws.dynamodb_table_module.rst | 117 +- docs/community.aws.ec2_eip_module.rst | 36 + docs/community.aws.ec2_elb_info_module.rst | 2 +- docs/community.aws.ec2_lc_find_module.rst | 1 - docs/community.aws.ec2_lc_module.rst | 5 +- .../community.aws.ec2_win_password_module.rst | 5 +- docs/community.aws.ecs_service_module.rst | 20 + ...ommunity.aws.ecs_taskdefinition_module.rst | 53 +- docs/community.aws.efs_module.rst | 44 + docs/community.aws.elb_instance_module.rst | 46 +- docs/community.aws.elb_network_lb_module.rst | 19 +- .../community.aws.elb_target_group_module.rst | 44 + ...mmunity.aws.iam_access_key_info_module.rst | 379 +++++ docs/community.aws.iam_access_key_module.rst | 499 +++++++ docs/community.aws.iam_module.rst | 2 +- docs/community.aws.iam_policy_module.rst | 6 +- docs/community.aws.iam_role_module.rst | 39 +- ...ity.aws.iam_server_certificate_module.rst} | 29 +- docs/community.aws.iam_user_info_module.rst | 18 + docs/community.aws.iam_user_module.rst | 61 + docs/community.aws.lambda_facts_module.rst | 2 +- docs/community.aws.lambda_info_module.rst | 2 +- ...community.aws.rds_instance_info_module.rst | 18 + ...nity.aws.rds_instance_snapshot_module.rst} | 12 +- docs/community.aws.rds_module.rst | 2 +- ...unity.aws.rds_option_group_info_module.rst | 963 ++++++++++++ .../community.aws.rds_option_group_module.rst | 1307 +++++++++++++++++ .../community.aws.rds_subnet_group_module.rst | 2 +- ...unity.aws.redshift_subnet_group_module.rst | 112 +- ...munity.aws.route53_health_check_module.rst | 357 ++++- docs/community.aws.route53_module.rst | 2 +- docs/community.aws.route53_zone_module.rst | 66 + docs/community.aws.sns_topic_module.rst | 275 +++- docs/community.aws.sqs_queue_module.rst | 2 +- galaxy.yml | 4 +- tests/requirements.yml | 4 +- 79 files changed, 4731 insertions(+), 260 deletions(-) delete mode 100644 changelogs/fragments/0-copy_ignore_txt.yml delete mode 100644 changelogs/fragments/228-ecs_service-force_delete.yml delete mode 100644 changelogs/fragments/332-ec2_eip-tagging.yml delete mode 100644 changelogs/fragments/375-lambda_info-tags.yml delete mode 100644 changelogs/fragments/384-elb_instance-python3-fixups.yml delete mode 100644 changelogs/fragments/522-efs-IA-transition.yml delete mode 100644 changelogs/fragments/557-action_group-missing-entry.yml delete mode 100644 changelogs/fragments/565-route53-tagging.yml delete mode 100644 changelogs/fragments/595-fix-route53-identifer.yaml delete mode 100644 changelogs/fragments/670-elb_target_group-new_attriibutes.yml delete mode 100644 changelogs/fragments/693-elb_classic_lb_info-without-names.yml delete mode 100644 changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml delete mode 100644 changelogs/fragments/724-redshift_subnet_group-boto3.yml delete mode 100644 changelogs/fragments/726-dynamodb_table-boto3.yml delete mode 100644 changelogs/fragments/728-iam_cert.yml delete mode 100644 changelogs/fragments/731-ec2_eip-not_in_vpc.yml delete mode 100644 changelogs/fragments/734-route53_health_check.yml delete mode 100644 changelogs/fragments/735-iam_server_certificate-file-names.yml delete mode 100644 changelogs/fragments/737-iam_server_certificate-boto3.yml delete mode 100644 changelogs/fragments/739-sns_topic-delivery_policy-shape.yml delete mode 100644 changelogs/fragments/741-ecs_taskdefinition-placement.yml delete mode 100644 changelogs/fragments/747-rds-enhanced-monitoring-bug-fix.yml delete mode 100644 changelogs/fragments/748-iam_role_info-jittered-backoff.yaml delete mode 100644 changelogs/fragments/753-dynamodb-billing_mode.yml delete mode 100644 changelogs/fragments/756-route53_health_check-disable.yml delete mode 100644 changelogs/fragments/759-ec2_win_password.yml delete mode 100644 changelogs/fragments/762-fix-kmsmasterkeyid-attr.yaml delete mode 100644 changelogs/fragments/764-awsretry-backoff.yml delete mode 100644 changelogs/fragments/765-route53_health_check-tags.yml delete mode 100644 changelogs/fragments/767-iam_role-add-waiter-support.yml delete mode 100644 changelogs/fragments/773-elb_instance-boto3.yml delete mode 100644 changelogs/fragments/774-add-aws_kms_parameters.yml delete mode 100644 changelogs/fragments/777-lambda_info-awsretry.yml delete mode 100644 changelogs/fragments/780-fix-cloudfront_info-pagination.yml delete mode 100644 changelogs/fragments/783-rds_snapshot.yml delete mode 100644 changelogs/fragments/798-fix-route53-empty-result.yaml delete mode 100644 changelogs/fragments/802-fix-diif-mode.yml create mode 100644 docs/community.aws.iam_access_key_info_module.rst create mode 100644 docs/community.aws.iam_access_key_module.rst rename docs/{community.aws.iam_cert_module.rst => community.aws.iam_server_certificate_module.rst} (94%) rename docs/{community.aws.rds_snapshot_module.rst => community.aws.rds_instance_snapshot_module.rst} (99%) create mode 100644 docs/community.aws.rds_option_group_info_module.rst create mode 100644 docs/community.aws.rds_option_group_module.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3c330f1d0f6..787b8c5ab44 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,95 @@ community.aws Release Notes .. contents:: Topics +v2.1.0 +====== + +Minor Changes +------------- + +- aws_config_delivery_channel - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_direct_connect_confirm_connection - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_direct_connect_connection - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_direct_connect_link_aggregation_group - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_direct_connect_virtual_interface - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_inspector_target - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_kms - add support for ``kms_spec`` and ``kms_usage`` parameter (https://github.com/ansible-collections/community.aws/pull/774). +- aws_kms - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- aws_kms_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- cloudformation_stack_set - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer connections (https://github.com/ansible-collections/community.aws/pull/707). +- dms_endpoint - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- dms_replication_subnet_group - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- dynamodb_table - add support for setting the `billing_mode` option (https://github.com/ansible-collections/community.aws/pull/753). +- dynamodb_table - the module has been updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/726). +- ec2_asg - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- ec2_eip - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). +- ec2_eip_info - added automatic retries for common temporary API failures (https://github.com/ansible-collections/community.aws/pull/332). +- ec2_eip_info - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). +- ec2_elb_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- ec2_win_password - module updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/759). +- ecs_service - added support for forcing deletion of a service (https://github.com/ansible-collections/community.aws/pull/228). +- ecs_service_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- ecs_taskdefinition - add ``placement_constraints`` option (https://github.com/ansible-collections/community.aws/pull/741). +- efs - add ``transition_to_ia`` parameter to support specifying the number of days before transitioning data to inactive storage (https://github.com/ansible-collections/community.aws/pull/522). +- elb_instance - added new ``updated_elbs`` return value (https://github.com/ansible-collections/community.aws/pull/773). +- elb_instance - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/773). +- elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). +- elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). +- iam_managed_policy - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- iam_role - Added `wait` option for IAM role creation / updates (https://github.com/ansible-collections/community.aws/pull/767). +- iam_saml_federation - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- iam_server_certificate - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/737). +- iam_server_certificate - migrate module to using the boto3 SDK (https://github.com/ansible-collections/community.aws/pull/737). +- lambda_info - add automatic retries for recoverable errors (https://github.com/ansible-collections/community.aws/pull/777). +- lambda_info - add support for tags (https://github.com/ansible-collections/community.aws/pull/375). +- lambda_info - use paginator for list queries (https://github.com/ansible-collections/community.aws/pull/777). +- rds - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). +- redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - the ``group_description`` option has been renamed to ``description`` and is now optional. The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` and is now only required when creating a new group. The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). +- redshift_subnet_group - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/724). +- route53_health_check - add support for tagging health checks (https://github.com/ansible-collections/community.aws/pull/765). +- route53_health_check - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/734). +- route53_health_check - added support for disabling health checks (https://github.com/ansible-collections/community.aws/pull/756). +- route53_health_check - migrated to boto3 SDK (https://github.com/ansible-collections/community.aws/pull/734). +- route53_zone - add support for tagging Route 53 zones (https://github.com/ansible-collections/community.aws/pull/565). +- sqs_queue - Providing a kms_master_key_id will now enable SSE properly (https://github.com/ansible-collections/community.aws/pull/762) + +Deprecated Features +------------------- + +- dynamodb_table - DynamoDB does not support specifying non-key-attributes when creating an ``ALL`` index. Passing ``includes`` for such indexes is currently ignored but will result in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). +- dynamodb_table - DynamoDB does not support updating the primary indexes on a table. Attempts to make such changes are currently ignored but will result in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). +- elb_instance - setting of the ``ec2_elb`` fact has been deprecated and will be removed in release 4.0.0 of the collection. See the module documentation for an alternative example using the register keyword (https://github.com/ansible-collections/community.aws/pull/773). +- iam_cert - the iam_cert module has been renamed to iam_server_certificate for consistency with the companion iam_server_certificate_info module. The usage of the module has not changed. The iam_cert alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). +- iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` and ``key`` parameters has been deprecated. We recommend using a lookup plugin to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). +- iam_server_certificate - the default value for the ``dup_ok`` parameter is currently ``false``, in version 4.0.0 this will be updated to ``true``. To preserve the current behaviour explicitly set the ``dup_ok`` parameter to ``false`` (https://github.com/ansible-collections/community.aws/pull/737). +- rds_snapshot - the rds_snapshot module has been renamed to rds_instance_snapshot. The usage of the module has not changed. The rds_snapshot alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/783). + +Bugfixes +-------- + +- AWS action group - added missing ``aws_direct_connect_confirm_connection`` and ``efs_tag`` entries (https://github.com/ansible-collections/amazon.aws/issues/557). +- cloudfront_info - Switch to native boto3 paginators to fix reported bug when over 100 distributions exist (https://github.com/ansible-collections/community.aws/issues/769). +- ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). +- elb_classic_lb_info - fix empty list returned when names not defined (https://github.com/ansible-collections/community.aws/pull/693). +- elb_instance - Python 3 compatability fix (https://github.com/ansible-collections/community.aws/issues/384). +- iam_role_info - switch to jittered backoff to reduce rate limiting failures (https://github.com/ansible-collections/community.aws/pull/748). +- rds_instance - Fixed issue with enabling enhanced monitoring on a pre-existing RDS instance (https://github.com/ansible-collections/community.aws/pull/747). +- route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). +- route53 - fix diff mode when deleting records (https://github.com/ansible-collections/community.aws/pull/802). +- route53 - return empty result for nonexistent records (https://github.com/ansible-collections/community.aws/pull/799). +- sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). + +New Modules +----------- + +- iam_access_key - Manage AWS IAM User access keys +- iam_access_key_info - fetch information about AWS IAM User access keys +- rds_option_group - rds_option_group module +- rds_option_group_info - rds_option_group_info module + v2.0.0 ====== diff --git a/README.md b/README.md index a04e88b9e9d..82aec47a77d 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Name | Description [community.aws.ec2_vpc_vgw_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_vgw_info_module.rst)|Gather information about virtual gateways in AWS [community.aws.ec2_vpc_vpn](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_vpn_module.rst)|Create, modify, and delete EC2 VPN connections. [community.aws.ec2_vpc_vpn_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_vpc_vpn_info_module.rst)|Gather information about VPN Connections in AWS. -[community.aws.ec2_win_password](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_win_password_module.rst)|Gets the default administrator password for ec2 windows instances +[community.aws.ec2_win_password](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_win_password_module.rst)|Gets the default administrator password for EC2 Windows instances [community.aws.ecs_attribute](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_attribute_module.rst)|manage ecs attributes [community.aws.ecs_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_cluster_module.rst)|Create or terminate ECS clusters. [community.aws.ecs_ecr](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ecs_ecr_module.rst)|Manage Elastic Container Registry repositories @@ -152,7 +152,8 @@ Name | Description [community.aws.elb_target_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_target_info_module.rst)|Gathers which target groups a target is associated with. [community.aws.execute_lambda](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.execute_lambda_module.rst)|Execute an AWS Lambda function [community.aws.iam](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_module.rst)|Manage IAM users, groups, roles and keys -[community.aws.iam_cert](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_cert_module.rst)|Manage server certificates for use on ELBs and CloudFront +[community.aws.iam_access_key](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_access_key_module.rst)|Manage AWS IAM User access keys +[community.aws.iam_access_key_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_access_key_info_module.rst)|fetch information about AWS IAM User access keys [community.aws.iam_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_group_module.rst)|Manage AWS IAM groups [community.aws.iam_managed_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_managed_policy_module.rst)|Manage User Managed IAM policies [community.aws.iam_mfa_device_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_mfa_device_info_module.rst)|List the MFA (Multi-Factor Authentication) devices registered for a user @@ -162,6 +163,7 @@ Name | Description [community.aws.iam_role](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_role_module.rst)|Manage AWS IAM roles [community.aws.iam_role_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_role_info_module.rst)|Gather information on IAM roles [community.aws.iam_saml_federation](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_saml_federation_module.rst)|Maintain IAM SAML federation configuration. +[community.aws.iam_server_certificate](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_server_certificate_module.rst)|Manage server certificates for use on ELBs and CloudFront [community.aws.iam_server_certificate_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_server_certificate_info_module.rst)|Retrieve the information of a server certificate [community.aws.iam_user](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_user_module.rst)|Manage AWS IAM users [community.aws.iam_user_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_user_info_module.rst)|Gather IAM user(s) facts in AWS @@ -176,8 +178,10 @@ Name | Description [community.aws.rds](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_module.rst)|create, delete, or modify Amazon rds instances, rds snapshots, and related facts [community.aws.rds_instance](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_instance_module.rst)|Manage RDS instances [community.aws.rds_instance_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_instance_info_module.rst)|obtain information about one or more RDS instances +[community.aws.rds_instance_snapshot](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_instance_snapshot_module.rst)|manage Amazon RDS snapshots. +[community.aws.rds_option_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_option_group_module.rst)|rds_option_group module +[community.aws.rds_option_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_option_group_info_module.rst)|rds_option_group_info module [community.aws.rds_param_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_param_group_module.rst)|manage RDS parameter groups -[community.aws.rds_snapshot](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_snapshot_module.rst)|manage Amazon RDS snapshots. [community.aws.rds_snapshot_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_snapshot_info_module.rst)|obtain information about one or more RDS snapshots [community.aws.rds_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.rds_subnet_group_module.rst)|manage RDS database subnet groups [community.aws.redshift](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.redshift_module.rst)|create, delete, or modify an Amazon Redshift instance @@ -185,7 +189,7 @@ Name | Description [community.aws.redshift_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.redshift_info_module.rst)|Gather information about Redshift cluster(s) [community.aws.redshift_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.redshift_subnet_group_module.rst)|manage Redshift cluster subnet groups [community.aws.route53](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.route53_module.rst)|add or delete entries in Amazons Route 53 DNS service -[community.aws.route53_health_check](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.route53_health_check_module.rst)|Add or delete health-checks in Amazons Route53 DNS service +[community.aws.route53_health_check](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.route53_health_check_module.rst)|Manage health-checks in Amazons Route53 DNS service [community.aws.route53_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.route53_info_module.rst)|Retrieves route53 details using AWS methods [community.aws.route53_zone](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.route53_zone_module.rst)|add or delete Route53 zones [community.aws.s3_bucket_notification](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_bucket_notification_module.rst)|Creates, updates or deletes S3 Bucket notification for lambda diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index ca10bd97e9e..e5302aad24d 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1344,3 +1344,159 @@ releases: name: efs_tag namespace: '' release_date: '2021-09-14' + 2.1.0: + changes: + bugfixes: + - AWS action group - added missing ``aws_direct_connect_confirm_connection`` + and ``efs_tag`` entries (https://github.com/ansible-collections/amazon.aws/issues/557). + - cloudfront_info - Switch to native boto3 paginators to fix reported bug when + over 100 distributions exist (https://github.com/ansible-collections/community.aws/issues/769). + - ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). + - elb_classic_lb_info - fix empty list returned when names not defined (https://github.com/ansible-collections/community.aws/pull/693). + - elb_instance - Python 3 compatability fix (https://github.com/ansible-collections/community.aws/issues/384). + - iam_role_info - switch to jittered backoff to reduce rate limiting failures + (https://github.com/ansible-collections/community.aws/pull/748). + - rds_instance - Fixed issue with enabling enhanced monitoring on a pre-existing + RDS instance (https://github.com/ansible-collections/community.aws/pull/747). + - route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). + - route53 - fix diff mode when deleting records (https://github.com/ansible-collections/community.aws/pull/802). + - route53 - return empty result for nonexistent records (https://github.com/ansible-collections/community.aws/pull/799). + - sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). + deprecated_features: + - dynamodb_table - DynamoDB does not support specifying non-key-attributes when + creating an ``ALL`` index. Passing ``includes`` for such indexes is currently + ignored but will result in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). + - dynamodb_table - DynamoDB does not support updating the primary indexes on + a table. Attempts to make such changes are currently ignored but will result + in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). + - elb_instance - setting of the ``ec2_elb`` fact has been deprecated and will + be removed in release 4.0.0 of the collection. See the module documentation + for an alternative example using the register keyword (https://github.com/ansible-collections/community.aws/pull/773). + - iam_cert - the iam_cert module has been renamed to iam_server_certificate + for consistency with the companion iam_server_certificate_info module. The + usage of the module has not changed. The iam_cert alias will be removed in + version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). + - iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` + and ``key`` parameters has been deprecated. We recommend using a lookup plugin + to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). + - iam_server_certificate - the default value for the ``dup_ok`` parameter is + currently ``false``, in version 4.0.0 this will be updated to ``true``. To + preserve the current behaviour explicitly set the ``dup_ok`` parameter to + ``false`` (https://github.com/ansible-collections/community.aws/pull/737). + - rds_snapshot - the rds_snapshot module has been renamed to rds_instance_snapshot. + The usage of the module has not changed. The rds_snapshot alias will be removed + in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/783). + minor_changes: + - aws_config_delivery_channel - replaced use of deprecated backoff decorator + (https://github.com/ansible-collections/community.aws/pull/764). + - aws_direct_connect_confirm_connection - replaced use of deprecated backoff + decorator (https://github.com/ansible-collections/community.aws/pull/764). + - aws_direct_connect_connection - replaced use of deprecated backoff decorator + (https://github.com/ansible-collections/community.aws/pull/764). + - aws_direct_connect_link_aggregation_group - replaced use of deprecated backoff + decorator (https://github.com/ansible-collections/community.aws/pull/764). + - aws_direct_connect_virtual_interface - replaced use of deprecated backoff + decorator (https://github.com/ansible-collections/community.aws/pull/764). + - aws_inspector_target - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - aws_kms - add support for ``kms_spec`` and ``kms_usage`` parameter (https://github.com/ansible-collections/community.aws/pull/774). + - aws_kms - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - aws_kms_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - cloudformation_stack_set - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer + connections (https://github.com/ansible-collections/community.aws/pull/707). + - dms_endpoint - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - dms_replication_subnet_group - replaced use of deprecated backoff decorator + (https://github.com/ansible-collections/community.aws/pull/764). + - dynamodb_table - add support for setting the `billing_mode` option (https://github.com/ansible-collections/community.aws/pull/753). + - dynamodb_table - the module has been updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/726). + - ec2_asg - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - ec2_eip - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). + - ec2_eip_info - added automatic retries for common temporary API failures (https://github.com/ansible-collections/community.aws/pull/332). + - ec2_eip_info - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). + - ec2_elb_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - ec2_win_password - module updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/759). + - ecs_service - added support for forcing deletion of a service (https://github.com/ansible-collections/community.aws/pull/228). + - ecs_service_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - ecs_taskdefinition - add ``placement_constraints`` option (https://github.com/ansible-collections/community.aws/pull/741). + - efs - add ``transition_to_ia`` parameter to support specifying the number + of days before transitioning data to inactive storage (https://github.com/ansible-collections/community.aws/pull/522). + - elb_instance - added new ``updated_elbs`` return value (https://github.com/ansible-collections/community.aws/pull/773). + - elb_instance - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/773). + - elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). + - elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). + - iam_managed_policy - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - iam_role - Added `wait` option for IAM role creation / updates (https://github.com/ansible-collections/community.aws/pull/767). + - iam_saml_federation - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - iam_server_certificate - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/737). + - iam_server_certificate - migrate module to using the boto3 SDK (https://github.com/ansible-collections/community.aws/pull/737). + - lambda_info - add automatic retries for recoverable errors (https://github.com/ansible-collections/community.aws/pull/777). + - lambda_info - add support for tags (https://github.com/ansible-collections/community.aws/pull/375). + - lambda_info - use paginator for list queries (https://github.com/ansible-collections/community.aws/pull/777). + - rds - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). + - redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). + - redshift_subnet_group - the ``group_description`` option has been renamed + to ``description`` and is now optional. The old parameter name will continue + to work (https://github.com/ansible-collections/community.aws/pull/724). + - redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` + and is now only required when creating a new group. The old parameter name + will continue to work (https://github.com/ansible-collections/community.aws/pull/724). + - redshift_subnet_group - the module has been migrated to the boto3 AWS SDK + (https://github.com/ansible-collections/community.aws/pull/724). + - route53_health_check - add support for tagging health checks (https://github.com/ansible-collections/community.aws/pull/765). + - route53_health_check - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/734). + - route53_health_check - added support for disabling health checks (https://github.com/ansible-collections/community.aws/pull/756). + - route53_health_check - migrated to boto3 SDK (https://github.com/ansible-collections/community.aws/pull/734). + - route53_zone - add support for tagging Route 53 zones (https://github.com/ansible-collections/community.aws/pull/565). + - sqs_queue - Providing a kms_master_key_id will now enable SSE properly (https://github.com/ansible-collections/community.aws/pull/762) + fragments: + - 0-copy_ignore_txt.yml + - 228-ecs_service-force_delete.yml + - 332-ec2_eip-tagging.yml + - 375-lambda_info-tags.yml + - 384-elb_instance-python3-fixups.yml + - 522-efs-IA-transition.yml + - 557-action_group-missing-entry.yml + - 565-route53-tagging.yml + - 595-fix-route53-identifer.yaml + - 670-elb_target_group-new_attriibutes.yml + - 693-elb_classic_lb_info-without-names.yml + - 707-add-cloudfront-new-security-policy-2021.yaml + - 724-redshift_subnet_group-boto3.yml + - 726-dynamodb_table-boto3.yml + - 728-iam_cert.yml + - 731-ec2_eip-not_in_vpc.yml + - 734-route53_health_check.yml + - 735-iam_server_certificate-file-names.yml + - 737-iam_server_certificate-boto3.yml + - 739-sns_topic-delivery_policy-shape.yml + - 741-ecs_taskdefinition-placement.yml + - 747-rds-enhanced-monitoring-bug-fix.yml + - 748-iam_role_info-jittered-backoff.yaml + - 753-dynamodb-billing_mode.yml + - 756-route53_health_check-disable.yml + - 759-ec2_win_password.yml + - 762-fix-kmsmasterkeyid-attr.yaml + - 764-awsretry-backoff.yml + - 765-route53_health_check-tags.yml + - 767-iam_role-add-waiter-support.yml + - 773-elb_instance-boto3.yml + - 774-add-aws_kms_parameters.yml + - 777-lambda_info-awsretry.yml + - 780-fix-cloudfront_info-pagination.yml + - 783-rds_snapshot.yml + - 798-fix-route53-empty-result.yaml + - 802-fix-diif-mode.yml + modules: + - description: Manage AWS IAM User access keys + name: iam_access_key + namespace: '' + - description: fetch information about AWS IAM User access keys + name: iam_access_key_info + namespace: '' + - description: rds_option_group module + name: rds_option_group + namespace: '' + - description: rds_option_group_info module + name: rds_option_group_info + namespace: '' + release_date: '2021-11-12' diff --git a/changelogs/fragments/0-copy_ignore_txt.yml b/changelogs/fragments/0-copy_ignore_txt.yml deleted file mode 100644 index ec804d278dd..00000000000 --- a/changelogs/fragments/0-copy_ignore_txt.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - Copy ignore.txt. diff --git a/changelogs/fragments/228-ecs_service-force_delete.yml b/changelogs/fragments/228-ecs_service-force_delete.yml deleted file mode 100644 index c0c4f68b021..00000000000 --- a/changelogs/fragments/228-ecs_service-force_delete.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ecs_service - added support for forcing deletion of a service (https://github.com/ansible-collections/community.aws/pull/228). diff --git a/changelogs/fragments/332-ec2_eip-tagging.yml b/changelogs/fragments/332-ec2_eip-tagging.yml deleted file mode 100644 index c9621b405fe..00000000000 --- a/changelogs/fragments/332-ec2_eip-tagging.yml +++ /dev/null @@ -1,4 +0,0 @@ -minor_changes: -- ec2_eip - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). -- ec2_eip_info - added support for tagging EIPs (https://github.com/ansible-collections/community.aws/pull/332). -- ec2_eip_info - added automatic retries for common temporary API failures (https://github.com/ansible-collections/community.aws/pull/332). diff --git a/changelogs/fragments/375-lambda_info-tags.yml b/changelogs/fragments/375-lambda_info-tags.yml deleted file mode 100644 index 6bbe48a4225..00000000000 --- a/changelogs/fragments/375-lambda_info-tags.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- lambda_info - add support for tags (https://github.com/ansible-collections/community.aws/pull/375). diff --git a/changelogs/fragments/384-elb_instance-python3-fixups.yml b/changelogs/fragments/384-elb_instance-python3-fixups.yml deleted file mode 100644 index f4a3fd7e897..00000000000 --- a/changelogs/fragments/384-elb_instance-python3-fixups.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- elb_instance - Python 3 compatability fix (https://github.com/ansible-collections/community.aws/issues/384). diff --git a/changelogs/fragments/522-efs-IA-transition.yml b/changelogs/fragments/522-efs-IA-transition.yml deleted file mode 100644 index aebba2e4499..00000000000 --- a/changelogs/fragments/522-efs-IA-transition.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- efs - add ``transition_to_ia`` parameter to support specifying the number of days before transitioning data to inactive storage (https://github.com/ansible-collections/community.aws/pull/522). diff --git a/changelogs/fragments/557-action_group-missing-entry.yml b/changelogs/fragments/557-action_group-missing-entry.yml deleted file mode 100644 index 77f5fb25142..00000000000 --- a/changelogs/fragments/557-action_group-missing-entry.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- AWS action group - added missing ``aws_direct_connect_confirm_connection`` and ``efs_tag`` entries (https://github.com/ansible-collections/amazon.aws/issues/557). diff --git a/changelogs/fragments/565-route53-tagging.yml b/changelogs/fragments/565-route53-tagging.yml deleted file mode 100644 index 0a46ad35e52..00000000000 --- a/changelogs/fragments/565-route53-tagging.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- route53_zone - add support for tagging Route 53 zones (https://github.com/ansible-collections/community.aws/pull/565). diff --git a/changelogs/fragments/595-fix-route53-identifer.yaml b/changelogs/fragments/595-fix-route53-identifer.yaml deleted file mode 100644 index 11901c1655b..00000000000 --- a/changelogs/fragments/595-fix-route53-identifer.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - route53 - add missing set identifier in resource_record_set (https://github.com/ansible-collections/community.aws/pull/595). diff --git a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml b/changelogs/fragments/670-elb_target_group-new_attriibutes.yml deleted file mode 100644 index bff32308d56..00000000000 --- a/changelogs/fragments/670-elb_target_group-new_attriibutes.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - elb_target_group - add ``preserve_client_ip_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). - - elb_target_group - add ``proxy_protocol_v2_enabled`` option (https://github.com/ansible-collections/community.aws/pull/670). \ No newline at end of file diff --git a/changelogs/fragments/693-elb_classic_lb_info-without-names.yml b/changelogs/fragments/693-elb_classic_lb_info-without-names.yml deleted file mode 100644 index 4e4d2a1a116..00000000000 --- a/changelogs/fragments/693-elb_classic_lb_info-without-names.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- elb_classic_lb_info - fix empty list returned when names not defined (https://github.com/ansible-collections/community.aws/pull/693). diff --git a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml b/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml deleted file mode 100644 index 82f82192f72..00000000000 --- a/changelogs/fragments/707-add-cloudfront-new-security-policy-2021.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- cloudfront_distribution - add ``TLSv1.2_2021`` security policy for viewer connections (https://github.com/ansible-collections/community.aws/pull/707). diff --git a/changelogs/fragments/724-redshift_subnet_group-boto3.yml b/changelogs/fragments/724-redshift_subnet_group-boto3.yml deleted file mode 100644 index d760eb4c2b8..00000000000 --- a/changelogs/fragments/724-redshift_subnet_group-boto3.yml +++ /dev/null @@ -1,7 +0,0 @@ -minor_changes: -- redshift_subnet_group - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_description`` option has been renamed to ``description`` and is now optional. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). -- redshift_subnet_group - the ``group_subnets`` option has been renamed to ``subnets`` and is now only required when creating a new group. - The old parameter name will continue to work (https://github.com/ansible-collections/community.aws/pull/724). diff --git a/changelogs/fragments/726-dynamodb_table-boto3.yml b/changelogs/fragments/726-dynamodb_table-boto3.yml deleted file mode 100644 index 5cd4ae98d65..00000000000 --- a/changelogs/fragments/726-dynamodb_table-boto3.yml +++ /dev/null @@ -1,5 +0,0 @@ -minor_changes: -- dynamodb_table - the module has been updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/726). -deprecated_features: -- dynamodb_table - DynamoDB does not support updating the primary indexes on a table. Attempts to make such changes are currently ignored but will result in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). -- dynamodb_table - DynamoDB does not support specifying non-key-attributes when creating an ``ALL`` index. Passing ``includes`` for such indexes is currently ignored but will result in failures after version 3.0.0 (https://github.com/ansible-collections/community.aws/pull/726). diff --git a/changelogs/fragments/728-iam_cert.yml b/changelogs/fragments/728-iam_cert.yml deleted file mode 100644 index 9fbb3d813cb..00000000000 --- a/changelogs/fragments/728-iam_cert.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_cert - the iam_cert module has been renamed to iam_server_certificate for consistency with the companion iam_server_certificate_info module. - The usage of the module has not changed. The iam_cert alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/728). diff --git a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml b/changelogs/fragments/731-ec2_eip-not_in_vpc.yml deleted file mode 100644 index 4020bffd273..00000000000 --- a/changelogs/fragments/731-ec2_eip-not_in_vpc.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- ec2_eip - fix bug when allocating an EIP but not associating it to a VPC (https://github.com/ansible-collections/community.aws/pull/731). diff --git a/changelogs/fragments/734-route53_health_check.yml b/changelogs/fragments/734-route53_health_check.yml deleted file mode 100644 index 338f118c75d..00000000000 --- a/changelogs/fragments/734-route53_health_check.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- route53_health_check - migrated to boto3 SDK (https://github.com/ansible-collections/community.aws/pull/734). -- route53_health_check - added support for check_mode (https://github.com/ansible-collections/community.aws/pull/734). diff --git a/changelogs/fragments/735-iam_server_certificate-file-names.yml b/changelogs/fragments/735-iam_server_certificate-file-names.yml deleted file mode 100644 index 58720919f7f..00000000000 --- a/changelogs/fragments/735-iam_server_certificate-file-names.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: -- iam_server_certificate - Passing file names to the ``cert``, ``chain_cert`` and ``key`` parameters has been deprecated. - We recommend using a lookup plugin to read the files instead, see the documentation for an example (https://github.com/ansible-collections/community.aws/pull/735). diff --git a/changelogs/fragments/737-iam_server_certificate-boto3.yml b/changelogs/fragments/737-iam_server_certificate-boto3.yml deleted file mode 100644 index 1449811a653..00000000000 --- a/changelogs/fragments/737-iam_server_certificate-boto3.yml +++ /dev/null @@ -1,7 +0,0 @@ -deprecated_features: -- iam_server_certificate - the default value for the ``dup_ok`` parameter is - currently ``false``, in version 4.0.0 this will be updated to ``true``. To - preserve the current behaviour explicitly set the ``dup_ok`` parameter to ``false`` (https://github.com/ansible-collections/community.aws/pull/737). -minor_changes: -- iam_server_certificate - migrate module to using the boto3 SDK (https://github.com/ansible-collections/community.aws/pull/737). -- iam_server_certificate - add support for check_mode (https://github.com/ansible-collections/community.aws/pull/737). diff --git a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml b/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml deleted file mode 100644 index 39f60733c2a..00000000000 --- a/changelogs/fragments/739-sns_topic-delivery_policy-shape.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- sns_topic - define suboptions for delivery_policy option (https://github.com/ansible-collections/community.aws/issues/713). diff --git a/changelogs/fragments/741-ecs_taskdefinition-placement.yml b/changelogs/fragments/741-ecs_taskdefinition-placement.yml deleted file mode 100644 index ac96c1af2c0..00000000000 --- a/changelogs/fragments/741-ecs_taskdefinition-placement.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - ecs_taskdefinition - add ``placement_constraints`` option (https://github.com/ansible-collections/community.aws/pull/741). diff --git a/changelogs/fragments/747-rds-enhanced-monitoring-bug-fix.yml b/changelogs/fragments/747-rds-enhanced-monitoring-bug-fix.yml deleted file mode 100644 index 9b1955d364c..00000000000 --- a/changelogs/fragments/747-rds-enhanced-monitoring-bug-fix.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- rds_instance - Fixed issue with enabling enhanced monitoring on a pre-existing RDS instance (https://github.com/ansible-collections/community.aws/pull/747). diff --git a/changelogs/fragments/748-iam_role_info-jittered-backoff.yaml b/changelogs/fragments/748-iam_role_info-jittered-backoff.yaml deleted file mode 100644 index 12c27b23945..00000000000 --- a/changelogs/fragments/748-iam_role_info-jittered-backoff.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - iam_role_info - switch to jittered backoff to reduce rate limiting failures (https://github.com/ansible-collections/community.aws/pull/748). diff --git a/changelogs/fragments/753-dynamodb-billing_mode.yml b/changelogs/fragments/753-dynamodb-billing_mode.yml deleted file mode 100644 index b883f45c8d4..00000000000 --- a/changelogs/fragments/753-dynamodb-billing_mode.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - dynamodb_table - add support for setting the `billing_mode` option (https://github.com/ansible-collections/community.aws/pull/753). diff --git a/changelogs/fragments/756-route53_health_check-disable.yml b/changelogs/fragments/756-route53_health_check-disable.yml deleted file mode 100644 index e307e2ab42a..00000000000 --- a/changelogs/fragments/756-route53_health_check-disable.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- route53_health_check - added support for disabling health checks (https://github.com/ansible-collections/community.aws/pull/756). diff --git a/changelogs/fragments/759-ec2_win_password.yml b/changelogs/fragments/759-ec2_win_password.yml deleted file mode 100644 index a13df0dd63e..00000000000 --- a/changelogs/fragments/759-ec2_win_password.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- ec2_win_password - module updated to use the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/759). diff --git a/changelogs/fragments/762-fix-kmsmasterkeyid-attr.yaml b/changelogs/fragments/762-fix-kmsmasterkeyid-attr.yaml deleted file mode 100644 index 2eb915f459c..00000000000 --- a/changelogs/fragments/762-fix-kmsmasterkeyid-attr.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- sqs_queue - Providing a kms_master_key_id will now enable SSE properly (https://github.com/ansible-collections/community.aws/pull/762) diff --git a/changelogs/fragments/764-awsretry-backoff.yml b/changelogs/fragments/764-awsretry-backoff.yml deleted file mode 100644 index af366e6b5ab..00000000000 --- a/changelogs/fragments/764-awsretry-backoff.yml +++ /dev/null @@ -1,18 +0,0 @@ -minor_changes: -- aws_config_delivery_channel - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_direct_connect_confirm_connection - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_direct_connect_connection - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_direct_connect_link_aggregation_group - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_direct_connect_virtual_interface - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_inspector_target - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_kms - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- aws_kms_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- cloudformation_stack_set - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- dms_endpoint - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- dms_replication_subnet_group - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- ec2_asg - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- ec2_elb_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- ecs_service_info - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- iam_managed_policy - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- iam_saml_federation - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). -- rds - replaced use of deprecated backoff decorator (https://github.com/ansible-collections/community.aws/pull/764). diff --git a/changelogs/fragments/765-route53_health_check-tags.yml b/changelogs/fragments/765-route53_health_check-tags.yml deleted file mode 100644 index 5f233ceb3cb..00000000000 --- a/changelogs/fragments/765-route53_health_check-tags.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- route53_health_check - add support for tagging health checks (https://github.com/ansible-collections/community.aws/pull/765). diff --git a/changelogs/fragments/767-iam_role-add-waiter-support.yml b/changelogs/fragments/767-iam_role-add-waiter-support.yml deleted file mode 100644 index d7e5c42153f..00000000000 --- a/changelogs/fragments/767-iam_role-add-waiter-support.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - iam_role - Added `wait` option for IAM role creation / updates (https://github.com/ansible-collections/community.aws/pull/767). diff --git a/changelogs/fragments/773-elb_instance-boto3.yml b/changelogs/fragments/773-elb_instance-boto3.yml deleted file mode 100644 index 09c231f27cf..00000000000 --- a/changelogs/fragments/773-elb_instance-boto3.yml +++ /dev/null @@ -1,7 +0,0 @@ -minor_changes: -- elb_instance - the module has been migrated to the boto3 AWS SDK (https://github.com/ansible-collections/community.aws/pull/773). -- elb_instance - added new ``updated_elbs`` return value (https://github.com/ansible-collections/community.aws/pull/773). -deprecated_features: -- elb_instance - setting of the ``ec2_elb`` fact has been deprecated and will be removed in release 4.0.0 of the collection. - See the module documentation for an alternative example using the register keyword - (https://github.com/ansible-collections/community.aws/pull/773). diff --git a/changelogs/fragments/774-add-aws_kms_parameters.yml b/changelogs/fragments/774-add-aws_kms_parameters.yml deleted file mode 100644 index ae58afa509c..00000000000 --- a/changelogs/fragments/774-add-aws_kms_parameters.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- aws_kms - add support for ``kms_spec`` and ``kms_usage`` parameter (https://github.com/ansible-collections/community.aws/pull/774). diff --git a/changelogs/fragments/777-lambda_info-awsretry.yml b/changelogs/fragments/777-lambda_info-awsretry.yml deleted file mode 100644 index 6b0db3d5263..00000000000 --- a/changelogs/fragments/777-lambda_info-awsretry.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: -- lambda_info - add automatic retries for recoverable errors (https://github.com/ansible-collections/community.aws/pull/777). -- lambda_info - use paginator for list queries (https://github.com/ansible-collections/community.aws/pull/777). diff --git a/changelogs/fragments/780-fix-cloudfront_info-pagination.yml b/changelogs/fragments/780-fix-cloudfront_info-pagination.yml deleted file mode 100644 index 5688eed4afd..00000000000 --- a/changelogs/fragments/780-fix-cloudfront_info-pagination.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - cloudfront_info - Switch to native boto3 paginators to fix reported bug when over 100 distributions exist (https://github.com/ansible-collections/community.aws/issues/769). diff --git a/changelogs/fragments/783-rds_snapshot.yml b/changelogs/fragments/783-rds_snapshot.yml deleted file mode 100644 index f073aa1748a..00000000000 --- a/changelogs/fragments/783-rds_snapshot.yml +++ /dev/null @@ -1,3 +0,0 @@ -deprecated_features: - - rds_snapshot - the rds_snapshot module has been renamed to rds_instance_snapshot. - The usage of the module has not changed. The rds_snapshot alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/783). diff --git a/changelogs/fragments/798-fix-route53-empty-result.yaml b/changelogs/fragments/798-fix-route53-empty-result.yaml deleted file mode 100644 index 61288a6af05..00000000000 --- a/changelogs/fragments/798-fix-route53-empty-result.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - route53 - return empty result for nonexistent records (https://github.com/ansible-collections/community.aws/pull/799). diff --git a/changelogs/fragments/802-fix-diif-mode.yml b/changelogs/fragments/802-fix-diif-mode.yml deleted file mode 100644 index 4be35cb0812..00000000000 --- a/changelogs/fragments/802-fix-diif-mode.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- route53 - fix diff mode when deleting records (https://github.com/ansible-collections/community.aws/pull/801). \ No newline at end of file diff --git a/docs/community.aws.aws_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index 4f774d36cef..d7bcb550856 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -19,7 +19,6 @@ Synopsis -------- - Allows for the management of API Gateway APIs. - Normally you should give the api_id since there is no other stable guaranteed unique identifier for the API. If you do not give api_id then a new API will be created each time this is run. -- Beware that there are very hard limits on the rate that you can call API Gateway's REST API. You may need to patch your boto. See https://github.com/boto/boto3/issues/876 and discuss it with your AWS rep. - swagger_file and swagger_text are passed directly on to AWS transparently whilst swagger_dict is an ansible dict which is converted to JSON before the API definitions are uploaded. diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index d51bc1bb2d5..3412509f0ea 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -331,6 +331,55 @@ Parameters

aliases: key_arn
+ + +
+ key_spec + +
+ string +
+
added in 2.1.0
+ + +
    Choices: +
  • SYMMETRIC_DEFAULT ←
    • +
  • RSA_2048
    • +
  • RSA_3072
    • +
  • RSA_4096
    • +
  • ECC_NIST_P256
    • +
  • ECC_NIST_P384
    • +
  • ECC_NIST_P521
    • +
  • ECC_SECG_P256K1
    • +
+ + +
Specifies the type of KMS key to create.
+
The specification is not changeable once the key is created.
+

aliases: customer_master_key_spec
+ + + + +
+ key_usage + +
+ string +
+
added in 2.1.0
+ + +
    Choices: +
  • ENCRYPT_DECRYPT ←
    • +
  • SIGN_VERIFY
    • +
+ + +
Determines the cryptographic operations for which you can use the KMS key.
+
The usage is not changeable once the key is created.
+ +
@@ -386,7 +435,7 @@ Parameters
(deprecated) If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.
Only cleans if changes are being made.
Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
-
This option has been deprecated, and will be removed in 2.13. Use policy instead.
+
This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead.

aliases: clean_invalid_entries
@@ -406,7 +455,7 @@ Parameters
(deprecated) List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin".
Required when policy_mode=grant.
Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
-
This option has been deprecated, and will be removed in 2.13. Use policy instead.
+
This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead.

aliases: grant_types
@@ -428,7 +477,7 @@ Parameters
(deprecated) Grant or deny access.
Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
-
This option has been deprecated, and will be removed in 2.13. Use policy instead.
+
This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead.

aliases: mode
@@ -447,7 +496,7 @@ Parameters
(deprecated) ARN of role to allow/deny access.
One of policy_role_name or policy_role_arn are required.
Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
-
This option has been deprecated, and will be removed in 2.13. Use policy instead.
+
This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead.

aliases: role_arn
@@ -466,7 +515,7 @@ Parameters
(deprecated) Role to allow/deny access.
One of policy_role_name or policy_role_arn are required.
Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
-
This option has been deprecated, and will be removed in 2.13. Use policy instead.
+
This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead.

aliases: role_name
diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 9766f960ce7..882c19e9528 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -600,7 +600,7 @@ Examples # When the module is called as cloudfront_facts, return values are published # in ansible_facts['cloudfront'][] and can be used as follows. - # Note that this is deprecated and will stop working in Ansible 2.13. + # Note that this is deprecated and will stop working in a release after 2021-12-01. - name: Gather facts community.aws.cloudfront_facts: distribution: true diff --git a/docs/community.aws.dynamodb_table_module.rst b/docs/community.aws.dynamodb_table_module.rst index a4c0979d3b6..49fad9eee32 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -27,10 +27,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 +- python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 -- python >= 3.6 Parameters @@ -114,6 +113,25 @@ Parameters

aliases: ec2_secret_key, secret_key
+ + +
+ billing_mode + +
+ string +
+ + +
    Choices: +
  • PROVISIONED
    • +
  • PAY_PER_REQUEST
    • +
+ + +
Controls whether provisoned pr on-demand tables are created.
+ +
@@ -162,7 +180,7 @@ Parameters
Name of the hash key.
-
Required when state=present.
+
Required when state=present and table doesn't exist.
@@ -176,13 +194,14 @@ Parameters
    Choices: -
  • STRING ←
    • +
  • STRING
  • NUMBER
  • BINARY
Type of the hash key.
+
Defaults to 'STRING' when creating a new table.
@@ -212,13 +231,14 @@ Parameters
string - / required
The name of the hash-based key.
+
Required if index doesn't already exist.
+
Can not be modified once the index has been created.
@@ -232,9 +252,16 @@ Parameters +
    Choices: +
  • STRING
    • +
  • NUMBER
    • +
  • BINARY
    • +
The type of the hash-based key.
+
Defaults to 'STRING' when creating a new index.
+
Can not be modified once the index has been created.
@@ -245,6 +272,7 @@ Parameters
list + / elements=string
@@ -284,6 +312,7 @@ Parameters
The name of the range-based key.
+
Can not be modified once the index has been created.
@@ -297,9 +326,16 @@ Parameters +
    Choices: +
  • STRING
    • +
  • NUMBER
    • +
  • BINARY
    • +
The type of the range-based key.
+
Defaults to 'STRING' when creating a new index.
+
Can not be modified once the index has been created.
@@ -330,10 +366,17 @@ Parameters +
    Choices: +
  • all
    • +
  • global_all
    • +
  • global_include
    • +
  • global_keys_only
    • +
  • include
    • +
  • keys_only
    • +
The type of index.
-
Valid types: all, global_all, global_include, global_keys_only, include, keys_only
@@ -386,6 +429,25 @@ Parameters

aliases: aws_profile
+ + +
+ purge_tags + +
+ boolean +
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Remove tags not listed in tags.
+ +
@@ -412,13 +474,14 @@ Parameters
    Choices: -
  • STRING ←
    • +
  • STRING
  • NUMBER
  • BINARY
Type of the range key.
+
Defaults to 'STRING' when creating a new range key.
@@ -431,10 +494,10 @@ Parameters - Default:
1
Read throughput capacity (units) to provision.
+
Defaults to 1 when creating a new table.
@@ -503,7 +566,7 @@ Parameters
A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag.
-
For example: {"key":"value"} and {"key":"value","key2":"value2"}
+
For example: {"key":"value"} or {"key":"value","key2":"value2"}
@@ -528,17 +591,37 @@ Parameters
- wait_for_active_timeout + wait + +
+ boolean +
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
When wait=True the module will wait for up to wait_timeout seconds for table creation or deletion to complete before returning.
+ + + + +
+ wait_timeout
integer
- Default:
60
+ Default:
300
-
how long before wait gives up, in seconds. only used when tags is set
+
How long (in seconds) to wait for creation / update / deletion to complete.
+

aliases: wait_for_active_timeout
@@ -551,10 +634,10 @@ Parameters - Default:
1
Write throughput capacity (units) to provision.
+
Defaults to 1 when creating a new table.
@@ -597,6 +680,14 @@ Examples read_capacity: 10 write_capacity: 10 + - name: Create pay-per-request table + community.aws.dynamodb_table: + name: my-table + region: us-east-1 + hash_key_name: id + hash_key_type: STRING + billing_mode: PAY_PER_REQUEST + - name: set index on existing dynamo table community.aws.dynamodb_table: name: my-table diff --git a/docs/community.aws.ec2_eip_module.rst b/docs/community.aws.ec2_eip_module.rst index 921e424b8ba..bb9f8238bf2 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -268,6 +268,26 @@ Parameters
Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn't validated when reuse_existing_ip_allowed=true.
+ + +
+ purge_tags + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Whether the tags argument should cause tags not in the dictionary to be removed.
+ +
@@ -390,6 +410,22 @@ Parameters
Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value.
+ + +
+ tags + +
+ dictionary +
+
added in 2.1.0
+ + + + +
A dictionary of tags to apply to the EIP.
+ +
diff --git a/docs/community.aws.ec2_elb_info_module.rst b/docs/community.aws.ec2_elb_info_module.rst index 4ccc2a76a92..a9d8888db6b 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -18,7 +18,7 @@ DEPRECATED ---------- :Removed in collection release after :Why: The ec2_elb_info is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`elb_classic_lb_info `. +:Alternative: Use :ref:`community.aws.elb_classic_lb_info `. diff --git a/docs/community.aws.ec2_lc_find_module.rst b/docs/community.aws.ec2_lc_find_module.rst index b4ef0e22906..b63f45c59f9 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -19,7 +19,6 @@ Synopsis -------- - Returns list of matching Launch Configurations for a given name, along with other useful information. - Results can be sorted and sliced. -- It depends on boto. - Based on the work by Tom Bamford https://github.com/tombamford diff --git a/docs/community.aws.ec2_lc_module.rst b/docs/community.aws.ec2_lc_module.rst index 2ce6e3fdd6f..2acba0c3904 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -751,7 +751,6 @@ Notes .. note:: - Amazon ASG Autoscaling Launch Configurations are immutable once created, so modifying the configuration after it is changed will not modify the launch configuration on AWS. You must create a new config and assign it to the ASG instead. - - encrypted volumes are supported on versions >= 2.4 - 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. @@ -764,9 +763,7 @@ Examples .. code-block:: yaml - # create a launch configuration using an AMI image and instance type as a basis - - - name: note that encrypted volumes are only supported in >= Ansible 2.4 + - name: create a launch configuration with an encrypted volume community.aws.ec2_lc: name: special image_id: ami-XXX diff --git a/docs/community.aws.ec2_win_password_module.rst b/docs/community.aws.ec2_win_password_module.rst index ddba8b42e43..c48180a2a4c 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -5,7 +5,7 @@ community.aws.ec2_win_password ****************************** -**Gets the default administrator password for ec2 windows instances** +**Gets the default administrator password for EC2 Windows instances** Version added: 1.0.0 @@ -18,7 +18,6 @@ Version added: 1.0.0 Synopsis -------- - Gets the default administrator password from any EC2 Windows instance. The instance is referenced by its id (e.g. ``i-XXXXXXX``). -- This module has a dependency on python-boto. @@ -26,7 +25,6 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 - boto3 >= 1.15.0 - botocore >= 1.18.0 - cryptography @@ -325,7 +323,6 @@ Notes ----- .. note:: - - As of Ansible 2.4, this module requires the python cryptography module rather than the older pycrypto module. - 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. diff --git a/docs/community.aws.ecs_service_module.rst b/docs/community.aws.ecs_service_module.rst index dc0663aaa06..d97a19d896f 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -257,6 +257,26 @@ Parameters

aliases: aws_endpoint_url, endpoint_url
+ + +
+ force_deletion + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Forcabily delete the service. Required when deleting a service with >0 scale, or no target group.
+ +
diff --git a/docs/community.aws.ecs_taskdefinition_module.rst b/docs/community.aws.ecs_taskdefinition_module.rst index 9de5fcbc0e3..4c64117d7a2 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -1871,11 +1871,62 @@ Parameters
The Docker networking mode to use for the containers in the task.
-
awsvpc mode was added in Ansible 2.5
Windows containers must use network_mode=default, which will utilize docker NAT networking.
Setting network_mode=default for a Linux container will use bridge mode.
+ + +
+ placement_constraints + +
+ list + / elements=dictionary +
+
added in 2.1.0
+ + + + +
Placement constraint objects to use for the task.
+
You can specify a maximum of 10 constraints per task.
+
Task placement constraints are not supported for tasks run on Fargate.
+ + + + + +
+ expression + +
+ string +
+ + + + +
A cluster query language expression to apply to the constraint.
+ + + + + +
+ type + +
+ string +
+ + + + +
The type of constraint.
+ + +
diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 60d6071897c..1fd9ff81a30 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -434,6 +434,32 @@ Parameters
The throughput_mode for the file system to be created.
+ + +
+ transition_to_ia + +
+ string +
+
added in 2.1.0
+ + +
    Choices: +
  • None
    • +
  • 7
    • +
  • 14
    • +
  • 30
    • +
  • 60
    • +
  • 90
    • +
+ + +
How many days before objects transition to the lower-cost EFS Infrequent Access (IA) storage class.
+
If set to the string None, any existing lifecyle policy will be removed, and objects will not transition to an IA storage class.
+
If this parameter is absent, any existing lifecycle policy will not be affected.
+ +
@@ -529,6 +555,24 @@ Examples - subnet_id: subnet-7654fdca security_groups: [ "sg-4c5d6f7a" ] + - name: Set a lifecycle policy + community.aws.efs: + state: present + name: myTestEFS + transition_to_ia: 7 + targets: + - subnet_id: subnet-7654fdca + security_groups: [ "sg-4c5d6f7a" ] + + - name: Remove a lifecycle policy + community.aws.efs: + state: present + name: myTestEFS + transition_to_ia: None + targets: + - subnet_id: subnet-7654fdca + security_groups: [ "sg-4c5d6f7a" ] + - name: Deleting EFS community.aws.efs: state: absent diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index 00248cbdebb..34952e99aa6 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -18,7 +18,6 @@ Version added: 1.0.0 Synopsis -------- - This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. -- Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. - Will be marked changed when called only if there are ELBs found to operate on. @@ -27,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 +- python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 -- python >= 3.6 Parameters @@ -146,8 +144,8 @@ Parameters -
List of ELB names, required for registration.
-
The ec2_elbs fact should be used if there was a previous de-register.
+
List of ELB names
+
Required when state=present.
@@ -199,7 +197,7 @@ Parameters -
EC2 Instance ID
+
EC2 Instance ID.
@@ -338,6 +336,7 @@ Notes ----- .. note:: + - The ec2_elb fact currently set by this module has been deprecated and will no longer be set after release 4.0.0 of the collection. - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE`` - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information. - Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information. @@ -356,6 +355,7 @@ Examples community.aws.elb_instance: instance_id: "{{ ansible_ec2_instance_id }}" state: absent + register: deregister_instances delegate_to: localhost roles: - myrole @@ -363,13 +363,43 @@ Examples - name: Instance Register community.aws.elb_instance: instance_id: "{{ ansible_ec2_instance_id }}" - ec2_elbs: "{{ item }}" + ec2_elbs: "{{ deregister_instances.updated_elbs }}" state: present delegate_to: localhost - loop: "{{ ec2_elbs }}" +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ updated_elbs + +
+ list + / elements=string +
+ 		always +
A list of ELB names that the instance has been added to or removed from.
+
+
+

+ Status ------ diff --git a/docs/community.aws.elb_network_lb_module.rst b/docs/community.aws.elb_network_lb_module.rst index fee52ab88f8..39af875a4ac 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -503,7 +503,7 @@ Parameters
Create or destroy the load balancer.
-
The current default is absent. However, this behavior is inconsistent with other modules and as such the default will change to present in 2.14. To maintain the existing behavior explicitly set state=absent.
+
The current default is absent. However, this behavior is inconsistent with other modules and as such the default will change to present in a release after 2022-06-01. To maintain the existing behavior explicitly set state=absent.
@@ -519,7 +519,7 @@ Parameters -
A list of dicts containing the IDs of the subnets to attach to the load balancer. You can also specify the allocation ID of an Elastic IP to attach to the load balancer. You can specify one Elastic IP address per subnet.
+
A list of dicts containing the IDs of the subnets to attach to the load balancer. You can also specify the allocation ID of an Elastic IP to attach to the load balancer or the internal IP address for an internal load balancer. You can specify one Elastic IP address or internal address per subnet.
This parameter is mutually exclusive with subnets.
@@ -661,6 +661,21 @@ Examples TargetGroupName: mytargetgroup # Required. The name of the target group state: present + - name: Create an internal ELB with a specified IP address + community.aws.elb_network_lb: + name: myelb + scheme: internal + subnet_mappings: + - SubnetId: subnet-012345678 + PrivateIPv4Address: 192.168.0.1 # Must be an address from within the CIDR of the subnet. + listeners: + - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive). + Port: 80 # Required. The port on which the load balancer is listening. + DefaultActions: + - Type: forward # Required. Only 'forward' is accepted at this time + TargetGroupName: mytargetgroup # Required. The name of the target group + state: present + - name: Remove an ELB community.aws.elb_network_lb: name: myelb diff --git a/docs/community.aws.elb_target_group_module.rst b/docs/community.aws.elb_target_group_module.rst index 9995592049d..e1f947db36d 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -317,6 +317,28 @@ Parameters
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if state is present.
+ + +
+ preserve_client_ip_enabled + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Indicates whether client IP preservation is enabled.
+
The default is disabled if the target group type is ip address and the target group protocol is tcp or tls. Otherwise, the default is enabled. Client IP preservation cannot be disabled for udp and tcp_udp target groups.
+
preserve_client_ip_enabled is supported only by Network Load Balancers.
+ +
@@ -363,6 +385,28 @@ Parameters
The protocol to use for routing traffic to the targets. Required when state is present.
+ + +
+ proxy_protocol_v2_enabled + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Indicates whether Proxy Protocol version 2 is enabled.
+
The value is true or false.
+
proxy_protocol_v2_enabled is supported only by Network Load Balancers.
+ +
diff --git a/docs/community.aws.iam_access_key_info_module.rst b/docs/community.aws.iam_access_key_info_module.rst new file mode 100644 index 00000000000..3865741b78c --- /dev/null +++ b/docs/community.aws.iam_access_key_info_module.rst @@ -0,0 +1,379 @@ +.. _community.aws.iam_access_key_info_module: + + +********************************* +community.aws.iam_access_key_info +********************************* + +**fetch information about AWS IAM User access keys** + + +Version added: 2.1.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Fetches information AWS IAM user access keys. +- Note: It is not possible to fetch the secret access key. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ aws_access_key + +
+ string +
+ 		+ +
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

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

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

aliases: aws_endpoint_url, endpoint_url
+
+
+ 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
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ security_token + +
+ string +
+ 		+ +
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

aliases: aws_security_token, access_token
+
+
+ user_name + +
+ string + / required +
+ 		+ +
The name of the IAM User to which the keys belong.
+

aliases: username
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+
+ + +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. + + - name: Fetch Access keys for a user + community.aws.iam_access_key_info: + user_name: example_user + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ access_key + +
+ list + / elements=dictionary +
+ 		When the key exists. +
A dictionary containing all the access key information.
+
+
  +
+ access_key_id + +
+ string +
+ 		success +
The ID for the access key.
+
+
Sample:
+
AKIA1EXAMPLE1EXAMPLE
+
  +
+ create_date + +
+ string +
+ 		success +
The date and time, in ISO 8601 date-time format, when the access key was created.
+
+
Sample:
+
2021-10-09T13:25:42+00:00
+
  +
+ status + +
+ string +
+ 		success +
The status of the key.
+
Active means it can be used.
+
Inactive means it can not be used.
+
+
Sample:
+
Inactive
+
  +
+ user_name + +
+ string +
+ 		success +
The name of the IAM user to which the key is attached.
+
+
Sample:
+
example_user
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Mark Chappell (@tremble) diff --git a/docs/community.aws.iam_access_key_module.rst b/docs/community.aws.iam_access_key_module.rst new file mode 100644 index 00000000000..44048f8fda7 --- /dev/null +++ b/docs/community.aws.iam_access_key_module.rst @@ -0,0 +1,499 @@ +.. _community.aws.iam_access_key_module: + + +**************************** +community.aws.iam_access_key +**************************** + +**Manage AWS IAM User access keys** + + +Version added: 2.1.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage AWS IAM user access keys. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ active + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whether the key should be enabled or disabled.
+
Defaults to true when creating a new key.
+

aliases: enabled
+
+
+ aws_access_key + +
+ string +
+ 		+ +
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

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

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

aliases: aws_endpoint_url, endpoint_url
+
+
+ id + +
+ string +
+ 		+ +
The ID of the access key.
+
Required when state=absent.
+
Mutually exclusive with rotate_keys.
+
+
+ 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
+
+
+ region + +
+ string +
+ 		+ +
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+

aliases: aws_region, ec2_region
+
+
+ rotate_keys + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When there are already 2 access keys attached to the IAM user the oldest key will be removed and a new key created.
+
Ignored if state=absent
+
Mutually exclusive with id.
+
+
+ security_token + +
+ string +
+ 		+ +
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+
If profile is set this parameter is ignored.
+
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
+

aliases: aws_security_token, access_token
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Create or remove the access key.
+
When state=present and id is not defined a new key will be created.
+
+
+ user_name + +
+ string + / required +
+ 		+ +
The name of the IAM User to which the key belongs.
+

aliases: username
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+
+
+ + +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. + + - name: Create a new access key + community.aws.iam_access_key: + user_name: example_user + state: present + + - name: Delete the access_key + community.aws.iam_access_key: + name: example_user + access_key_id: AKIA1EXAMPLE1EXAMPLE + state: absent + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ access_key + +
+ complex +
+ 		When the key exists. +
A dictionary containing all the access key information.
+
+
  +
+ access_key_id + +
+ string +
+ 		success +
The ID for the access key.
+
+
Sample:
+
AKIA1EXAMPLE1EXAMPLE
+
  +
+ create_date + +
+ string +
+ 		success +
The date and time, in ISO 8601 date-time format, when the access key was created.
+
+
Sample:
+
2021-10-09T13:25:42+00:00
+
  +
+ status + +
+ string +
+ 		success +
The status of the key.
+
Active means it can be used.
+
Inactive means it can not be used.
+
+
Sample:
+
Inactive
+
  +
+ user_name + +
+ string +
+ 		success +
The name of the IAM user to which the key is attached.
+
+
Sample:
+
example_user
+
+
+ deleted_access_key_id + +
+ string +
+ 		When a key was deleted during the rotation of access keys +
The access key deleted during rotation.
+
+
Sample:
+
AKIA1EXAMPLE1EXAMPLE
+
+
+ secret_access_key + +
+ string +
+ 		When a new key is created. +
The secret access key.
+
A secret access key is the equivalent of a password which can not be changed and as such should be considered sensitive data.
+
Secret access keys can only be accessed at creation time.
+
+
Sample:
+
example/Example+EXAMPLE+example/Example
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Mark Chappell (@tremble) diff --git a/docs/community.aws.iam_module.rst b/docs/community.aws.iam_module.rst index 971d5afdcb3..1ad19f9c1ec 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -18,7 +18,7 @@ DEPRECATED ---------- :Removed in collection release after :Why: The iam module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`iam_user `, :ref:`iam_group `, :ref:`iam_role `, :ref:`iam_policy ` and :ref:`iam_managed_policy ` modules. +:Alternative: Use :ref:`community.aws.iam_user `, :ref:`community.aws.iam_group `, :ref:`community.aws.iam_role `, :ref:`community.aws.iam_policy ` and :ref:`community.aws.iam_managed_policy ` modules. diff --git a/docs/community.aws.iam_policy_module.rst b/docs/community.aws.iam_policy_module.rst index e5fc98f019e..ed654a7cfe5 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -198,7 +198,7 @@ Parameters
The path to the properly json formatted policy file.
Mutually exclusive with policy_json.
-
This option has been deprecated and will be removed in 2.14. The existing behavior can be reproduced by using the policy_json option and reading the file using the lookup plugin.
+
This option has been deprecated and will be removed in a release after 2022-06-01. The existing behavior can be reproduced by using the policy_json option and reading the file using the lookup plugin.
@@ -301,8 +301,8 @@ Parameters -
When skip_duplicates=true the module looks for any policies that match the document you pass in. If there is a match it will not make a new policy object with the same rules.
-
The current default is true. However, this behavior can be confusing and as such the default will change to false in 2.14. To maintain the existing behavior explicitly set skip_duplicates=true.
+
When skip_duplicates=true the module looks for any policies that match the document you pass in. If there is a match it will not make a new policy object with the same rules.
+
The current default is true. However, this behavior can be confusing and as such the default will change to false in a release after 2022-06-01. To maintain the existing behavior explicitly set skip_duplicates=true.
diff --git a/docs/community.aws.iam_role_module.rst b/docs/community.aws.iam_role_module.rst index b2f8568bf43..b8804888bfb 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -248,7 +248,7 @@ Parameters -
A list of managed policy ARNs or, since Ansible 2.4, a list of either managed policy ARNs or friendly names.
+
A list of managed policy ARNs, managed policy ARNs or friendly names.
To remove all policies set purge_polices=true and managed_policies=[None].
To embed an inline policy, use community.aws.iam_policy.

aliases: managed_policy
@@ -336,7 +336,7 @@ Parameters
When purge_policies=true any managed policies not listed in managed_policies will be detatched.
-
By default purge_policies=true. In Ansible 2.14 this will be changed to purge_policies=false.
+
By default purge_policies=true. In a release after 2022-06-01 this will be changed to purge_policies=false.

aliases: purge_policy, purge_managed_policies
@@ -446,6 +446,41 @@ Parameters
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+ + +
+ wait + +
+ boolean +
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
When wait=True the module will wait for up to wait_timeout seconds for IAM role creation before returning.
+ + + + +
+ wait_timeout + +
+ integer +
+ + + Default:
120
+ + +
How long (in seconds) to wait for creation / update to complete.
+ +
diff --git a/docs/community.aws.iam_cert_module.rst b/docs/community.aws.iam_server_certificate_module.rst similarity index 94% rename from docs/community.aws.iam_cert_module.rst rename to docs/community.aws.iam_server_certificate_module.rst index 7363b72fa27..e4a1451e5d4 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_server_certificate_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.iam_cert_module: +.. _community.aws.iam_server_certificate_module: -********************** -community.aws.iam_cert -********************** +************************************ +community.aws.iam_server_certificate +************************************ **Manage server certificates for use on ELBs and CloudFront** @@ -124,7 +124,9 @@ Parameters -
The path to, or content of the certificate body in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
+
The path to, or content of the certificate body in PEM encoded format.
+
If the parameter is not a file, it is assumed to be content.
+
Passing a file name is deprecated, and support will be dropped in version 4.0.0 of this collection.
@@ -139,7 +141,9 @@ Parameters -
The path to, or content of, the CA certificate chain in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
+
The path to, or content of, the CA certificate chain in PEM encoded format.
+
If the parameter is not a file, it is assumed to be content.
+
Passing a file name is deprecated, and support will be dropped in version 4.0.0 of this collection.
@@ -179,7 +183,7 @@ Parameters
By default the module will not upload a certificate that is already uploaded into AWS.
If dup_ok=True, it will upload the certificate as long as the name is unique.
-
Defaults to false.
+
Currently defaults to false, this will default to true in release 4.0.0.
@@ -210,7 +214,8 @@ Parameters -
The path to, or content of the private key in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
+
The path to, or content of the private key in PEM encoded format. If the parameter is not a file, it is assumed to be content.
+
Passing a file name is deprecated, and support will be dropped in version 4.0.0 of this collection.
@@ -389,7 +394,7 @@ Examples .. code-block:: yaml - name: Basic server certificate upload from local file - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present cert: "{{ lookup('file', 'path/to/cert') }}" @@ -397,7 +402,7 @@ Examples cert_chain: "{{ lookup('file', 'path/to/certchain') }}" - name: Basic server certificate upload - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present cert: path/to/cert @@ -405,7 +410,7 @@ Examples cert_chain: path/to/certchain - name: Server certificate upload using key string - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl state: present path: "/a/cert/path/" @@ -414,7 +419,7 @@ Examples cert_chain: body_of_myverytrustedchain - name: Basic rename of existing certificate - community.aws.iam_cert: + community.aws.iam_server_certificate: name: very_ssl new_name: new_very_ssl state: present diff --git a/docs/community.aws.iam_user_info_module.rst b/docs/community.aws.iam_user_info_module.rst index 1ad22f8cc81..2b90fd57575 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -400,6 +400,24 @@ Common return values are documented `here /dev/ + +   + +
+ tags + +
+ dictionary +
+ + if user exists + +
User tags.
+
+
Sample:
+
{"Env": "Prod"}
+ +   diff --git a/docs/community.aws.iam_user_module.rst b/docs/community.aws.iam_user_module.rst index 806451fa983..c596e3279be 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -217,6 +217,26 @@ Parameters

aliases: purge_policy, purge_managed_policies
+ + +
+ purge_tags + +
+ boolean +
+
added in 2.1.0
+ + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Remove tags not listed in tags when tags is specified.
+ +
@@ -271,6 +291,22 @@ Parameters
Create or remove the IAM user.
+ + +
+ tags + +
+ dictionary +
+
added in 2.1.0
+ + + + +
Tag dict to apply to the user.
+ +
@@ -333,6 +369,13 @@ Examples state: present purge_policies: true + - name: Create user with tags + community.aws.iam_user: + name: testuser1 + state: present + tags: + Env: Prod + - name: Delete the user community.aws.iam_user: name: testuser1 @@ -421,6 +464,24 @@ Common return values are documented `here / + +   + +
+ tags + +
+ dictionary +
+ + always + +
user tags
+
+
Sample:
+
{"Env": "Prod"}
+ +   diff --git a/docs/community.aws.lambda_facts_module.rst b/docs/community.aws.lambda_facts_module.rst index 417f3d17179..8abc4cb5149 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -388,7 +388,7 @@ Status ------ -- This module will be removed in version . *[deprecated]* +- This module will be removed in a release after 2021-12-01. *[deprecated]* - For more information see `DEPRECATED`_. diff --git a/docs/community.aws.lambda_info_module.rst b/docs/community.aws.lambda_info_module.rst index 2f08ea7159b..d702b6a8405 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -212,6 +212,7 @@ Parameters
  • mappings
  • policy
  • versions
    • +
  • tags
    • @@ -308,7 +309,6 @@ Examples - name: List all function community.aws.lambda_info: query: all - max_items: 20 register: output - name: show Lambda information ansible.builtin.debug: diff --git a/docs/community.aws.rds_instance_info_module.rst b/docs/community.aws.rds_instance_info_module.rst index 530ac744f26..e1777ebb65a 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -957,6 +957,24 @@ Common return values are documented `here 2017-10-10T04:00:07.434000+00:00 + +   + +
    + iops + +
    + integer +
    + + always + +
    The Provisioned IOPS value for the DB instance.
    +
    +
    Sample:
    +
    1000
    + +   diff --git a/docs/community.aws.rds_snapshot_module.rst b/docs/community.aws.rds_instance_snapshot_module.rst similarity index 99% rename from docs/community.aws.rds_snapshot_module.rst rename to docs/community.aws.rds_instance_snapshot_module.rst index 657b56b7165..8601f7b83d5 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_instance_snapshot_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.rds_snapshot_module: +.. _community.aws.rds_instance_snapshot_module: -************************** -community.aws.rds_snapshot -************************** +*********************************** +community.aws.rds_instance_snapshot +*********************************** **manage Amazon RDS snapshots.** @@ -358,12 +358,12 @@ Examples .. code-block:: yaml - name: Create snapshot - community.aws.rds_snapshot: + community.aws.rds_instance_snapshot: db_instance_identifier: new-database db_snapshot_identifier: new-database-snapshot - name: Delete snapshot - community.aws.rds_snapshot: + community.aws.rds_instance_snapshot: db_snapshot_identifier: new-database-snapshot state: absent diff --git a/docs/community.aws.rds_module.rst b/docs/community.aws.rds_module.rst index 76da476f977..a9ee106a16a 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -18,7 +18,7 @@ DEPRECATED ---------- :Removed in collection release after :Why: The rds module is based upon a deprecated version of the AWS SDK. -:Alternative: Use :ref:`rds_instance `, :ref:`rds_instance_info `, and :ref:`rds_snapshot `. +:Alternative: Use :ref:`community.aws.rds_instance `, :ref:`community.aws.rds_instance_info `, and :ref:`community.aws.rds_instance_snapshot `. diff --git a/docs/community.aws.rds_option_group_info_module.rst b/docs/community.aws.rds_option_group_info_module.rst new file mode 100644 index 00000000000..6c8aaa81e4c --- /dev/null +++ b/docs/community.aws.rds_option_group_info_module.rst @@ -0,0 +1,963 @@ +.. _community.aws.rds_option_group_info_module: + + +*********************************** +community.aws.rds_option_group_info +*********************************** + +**rds_option_group_info module** + + +Version added: 2.1.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Gather information about RDS option groups. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterChoices/DefaultsComments
    +
    + aws_access_key + +
    + string +
    +     		+ +
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
    +

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

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

    aliases: aws_endpoint_url, endpoint_url
    +
    +
    + engine_name + +
    + string +
    +     		+ Default:
    ""
    +     		+
    Filters the list of option groups to only include groups associated with a specific database engine.
    +
    +
    + major_engine_version + +
    + string +
    +     		+ Default:
    ""
    +     		+
    Filters the list of option groups to only include groups associated with a specific database engine version.
    +
    If specified, then engine_name must also be specified.
    +
    +
    + marker + +
    + string +
    +     		+ Default:
    ""
    +     		+
    If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max_records.
    +
    Allowed values are between 20 and 100.
    +
    +
    + max_records + +
    + integer +
    +     		+ Default:
    100
    +     		+
    The maximum number of records to include in the response.
    +
    +
    + option_group_name + +
    + string +
    +     		+ Default:
    ""
    +     		+
    The name of the option group to describe.
    +
    Can't be supplied together with engine_name or major_engine_version.
    +
    +
    + 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
    +
    +
    + region + +
    + string +
    +     		+ +
    The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
    +

    aliases: aws_region, ec2_region
    +
    +
    + security_token + +
    + string +
    +     		+ +
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
    +

    aliases: aws_security_token, access_token
    +
    +
    + validate_certs + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes ←
      • +
    +     		+
    When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
    +
    +
    + + +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. + + - name: List an option group + community.aws.rds_option_group_info: + option_group_name: test-mysql-option-group + register: option_group + + - name: List all the option groups + community.aws.rds_option_group_info: + region: ap-southeast-2 + profile: production + register: option_group + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyReturnedDescription
    +
    + changed + +
    + boolean +
    +     		always +
    True if listing the RDS option group succeeds.
    +
    +
    +
    + option_groups_list + +
    + complex +
    +     		always +
    The available RDS option groups.
    +
    +
      +
    + allows_vpc_and_non_vpc_instance_memberships + +
    + boolean +
    +     		always +
    Indicates whether this option group can be applied to both VPC and non-VPC instances.
    +
    +
      +
    + engine_name + +
    + string +
    +     		always +
    Indicates the name of the engine that this option group can be applied to.
    +
    +
    Sample:
    +
    mysql
    +
      +
    + major_engine_version + +
    + string +
    +     		always +
    Indicates the major engine version associated with this option group.
    +
    +
    Sample:
    +
    5.6
    +
      +
    + option_group_arn + +
    + string +
    +     		always +
    The Amazon Resource Name (ARN) for the option group.
    +
    +
    Sample:
    +
    arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group
    +
      +
    + option_group_description + +
    + string +
    +     		always +
    Provides a description of the option group.
    +
    +
    Sample:
    +
    test mysql option group
    +
      +
    + option_group_name + +
    + string +
    +     		always +
    Specifies the name of the option group.
    +
    +
    Sample:
    +
    test-mysql-option-group
    +
      +
    + options + +
    + complex +
    +     		always +
    Indicates what options are available in the option group.
    +
    +
       +
    + db_security_group_memberships + +
    + complex + / elements=dictionary +
    +     		always +
    If the option requires access to a port, then this DB security group allows access to the port.
    +
    +
    Sample:
    +
    list
    +
        +
    + db_security_group_name + +
    + string +
    +     		always +
    The name of the DB security group.
    +
    +
    Sample:
    +
    mydbsecuritygroup
    +
        +
    + status + +
    + string +
    +     		always +
    The status of the DB security group.
    +
    +
    Sample:
    +
    available
    +
       +
    + option_description + +
    + string +
    +     		always +
    The description of the option.
    +
    +
    Sample:
    +
    Innodb Memcached for MySQL
    +
       +
    + option_name + +
    + string +
    +     		always +
    The name of the option.
    +
    +
    Sample:
    +
    MEMCACHED
    +
       +
    + option_settings + +
    + complex +
    +     		always +
    The name of the option.
    +
    +
        +
    + allowed_values + +
    + string +
    +     		always +
    The allowed values of the option setting.
    +
    +
    Sample:
    +
    1-2048
    +
        +
    + apply_type + +
    + string +
    +     		always +
    The DB engine specific parameter type.
    +
    +
    Sample:
    +
    STATIC
    +
        +
    + data_type + +
    + string +
    +     		always +
    The data type of the option setting.
    +
    +
    Sample:
    +
    INTEGER
    +
        +
    + default_value + +
    + string +
    +     		always +
    The default value of the option setting.
    +
    +
    Sample:
    +
    1024
    +
        +
    + description + +
    + string +
    +     		always +
    The description of the option setting.
    +
    +
    Sample:
    +
    Verbose level for memcached.
    +
        +
    + is_collection + +
    + boolean +
    +     		always +
    Indicates if the option setting is part of a collection.
    +
    +
    Sample:
    +
    True
    +
        +
    + is_modifiable + +
    + boolean +
    +     		always +
    A Boolean value that, when true, indicates the option setting can be modified from the default.
    +
    +
    Sample:
    +
    True
    +
        +
    + name + +
    + string +
    +     		always +
    The name of the option that has settings that you can set.
    +
    +
    Sample:
    +
    INNODB_API_ENABLE_MDL
    +
        +
    + value + +
    + string +
    +     		always +
    The current value of the option setting.
    +
    +
    Sample:
    +
    0
    +
       +
    + permanent + +
    + boolean +
    +     		always +
    Indicate if this option is permanent.
    +
    +
    Sample:
    +
    True
    +
       +
    + persistent + +
    + boolean +
    +     		always +
    Indicate if this option is persistent.
    +
    +
    Sample:
    +
    True
    +
       +
    + port + +
    + integer +
    +     		always +
    If required, the port configured for this option to use.
    +
    +
    Sample:
    +
    11211
    +
       +
    + vpc_security_group_memberships + +
    + list + / elements=dictionary +
    +     		always +
    If the option requires access to a port, then this VPC security group allows access to the port.
    +
    +
        +
    + status + +
    + string +
    +     		always +
    The status of the VPC security group.
    +
    +
    Sample:
    +
    available
    +
        +
    + vpc_security_group_id + +
    + string +
    +     		always +
    The name of the VPC security group.
    +
    +
    Sample:
    +
    sg-0cd636a23ae76e9a4
    +
      +
    + tags + +
    + dictionary +
    +     		always +
    The tags associated the Internet Gateway.
    +
    +
    Sample:
    +
    {'Ansible': 'Test'}
    +
      +
    + vpc_id + +
    + string +
    +     		always +
    If present, this option group can only be applied to instances that are in the VPC indicated by this field.
    +
    +
    Sample:
    +
    vpc-bf07e9d6
    +
    +

    + + +Status +------ + + +Authors +~~~~~~~ + +- Alina Buzachis (@alinabuzachis) diff --git a/docs/community.aws.rds_option_group_module.rst b/docs/community.aws.rds_option_group_module.rst new file mode 100644 index 00000000000..e712b76ef8f --- /dev/null +++ b/docs/community.aws.rds_option_group_module.rst @@ -0,0 +1,1307 @@ +.. _community.aws.rds_option_group_module: + + +****************************** +community.aws.rds_option_group +****************************** + +**rds_option_group module** + + +Version added: 2.1.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manages the creation, modification, deletion of RDS option groups. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.15.0 +- botocore >= 1.18.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterChoices/DefaultsComments
    +
    + apply_immediately + +
    + boolean +
    +     		+
      Choices: +
    • no ←
      • +
    • yes
      • +
    +     		+
    Indicates whether the changes should be applied immediately, or during the next maintenance window.
    +
    +
    + aws_access_key + +
    + string +
    +     		+ +
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
    +

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

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

    aliases: aws_endpoint_url, endpoint_url
    +
    +
    + engine_name + +
    + string +
    +     		+ +
    Specifies the name of the engine that this option group should be associated with.
    +
    +
    + major_engine_version + +
    + string +
    +     		+ +
    Specifies the major version of the engine that this option group should be associated with.
    +
    +
    + option_group_description + +
    + string +
    +     		+ +
    The description of the option group.
    +
    +
    + option_group_name + +
    + string + / required +
    +     		+ +
    Specifies the name of the option group to be created.
    +
    +
    + options + +
    + list + / elements=dictionary +
    +     		+ +
    Options in this list are added to the option group.
    +
    If already present, the specified configuration is used to update the existing configuration.
    +
    If none are supplied, any existing options are removed.
    +
    +
    + db_security_group_memberships + +
    + list +
    +     		+ +
    A list of DBSecurityGroupMembership name strings used for this option.
    +
    +
    + option_name + +
    + string +
    +     		+ +
    The configuration of options to include in a group.
    +
    +
    + option_settings + +
    + list +
    +     		+ +
    The option settings to include in an option group.
    +
    +
    + allowed_values + +
    + string +
    +     		+ +
    The allowed values of the option setting.
    +
    +
    + apply_type + +
    + string +
    +     		+ +
    The DB engine specific parameter type.
    +
    +
    + data_type + +
    + string +
    +     		+ +
    The data type of the option setting.
    +
    +
    + default_value + +
    + string +
    +     		+ +
    The default value of the option setting.
    +
    +
    + description + +
    + string +
    +     		+ +
    The description of the option setting.
    +
    +
    + is_collection + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes
      • +
    +     		+
    Indicates if the option setting is part of a collection.
    +
    +
    + is_modifiable + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes
      • +
    +     		+
    A Boolean value that, when true, indicates the option setting can be modified from the default.
    +
    +
    + name + +
    + string +
    +     		+ +
    The name of the option that has settings that you can set.
    +
    +
    + value + +
    + string +
    +     		+ +
    The current value of the option setting.
    +
    +
    + option_version + +
    + string +
    +     		+ +
    The version for the option.
    +
    +
    + port + +
    + integer +
    +     		+ +
    The optional port for the option.
    +
    +
    + vpc_security_group_memberships + +
    + list +
    +     		+ +
    A list of VpcSecurityGroupMembership name strings used for this option.
    +
    +
    + profile + +
    + string +
    +     		+ +
    Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
    +
    aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
    +

    aliases: aws_profile
    +
    +
    + purge_tags + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes ←
      • +
    +     		+
    Remove tags not listed in tags.
    +
    +
    + region + +
    + string +
    +     		+ +
    The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
    +

    aliases: aws_region, ec2_region
    +
    +
    + security_token + +
    + string +
    +     		+ +
    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
    +
    If profile is set this parameter is ignored.
    +
    Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
    +

    aliases: aws_security_token, access_token
    +
    +
    + state + +
    + string + / required +
    +     		+
      Choices: +
    • present
      • +
    • absent
      • +
    +     		+
    Specifies whether the option group should be present or absent.
    +
    +
    + tags + +
    + dictionary +
    +     		+ +
    A dictionary of key value pairs to assign the option group.
    +
    To remove all tags set tags={} and purge_tags=true.
    +
    +
    + validate_certs + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes ←
      • +
    +     		+
    When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
    +
    +
    + wait + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes ←
      • +
    +     		+
    Whether to wait for the cluster to be available or deleted.
    +
    +
    + + +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 + + # Create an RDS Mysql Option group + - name: Create an RDS Mysql option group + community.aws.rds_option_group: + state: present + option_group_name: test-mysql-option-group + engine_name: mysql + major_engine_version: 5.6 + option_group_description: test mysql option group + apply_immediately: true + options: + - option_name: MEMCACHED + port: 11211 + vpc_security_group_memberships: + - "sg-d188c123" + option_settings: + - name: MAX_SIMULTANEOUS_CONNECTIONS + value: "20" + - name: CHUNK_SIZE_GROWTH_FACTOR + value: "1.25" + register: new_rds_mysql_option_group + + # Remove currently configured options for an option group by removing options argument + - name: Create an RDS Mysql option group + community.aws.rds_option_group: + state: present + option_group_name: test-mysql-option-group + engine_name: mysql + major_engine_version: 5.6 + option_group_description: test mysql option group + apply_immediately: true + register: rds_mysql_option_group + + - name: Create an RDS Mysql option group using tags + community.aws.rds_option_group: + state: present + option_group_name: test-mysql-option-group + engine_name: mysql + major_engine_version: 5.6 + option_group_description: test mysql option group + apply_immediately: true + tags: + Tag1: tag1 + Tag2: tag2 + register: rds_mysql_option_group + + # Delete an RDS Mysql Option group + - name: Delete an RDS Mysql option group + community.aws.rds_option_group: + state: absent + option_group_name: test-mysql-option-group + register: deleted_rds_mysql_option_group + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    KeyReturnedDescription
    +
    + allows_vpc_and_non_vpc_instance_memberships + +
    + boolean +
    +     		always +
    Indicates whether this option group can be applied to both VPC and non-VPC instances.
    +
    +
    +
    + changed + +
    + boolean +
    +     		always +
    If the Option Group has changed.
    +
    +
    Sample:
    +
    True
    +
    +
    + engine_name + +
    + string +
    +     		always +
    Indicates the name of the engine that this option group can be applied to.
    +
    +
    Sample:
    +
    mysql
    +
    +
    + major_engine_version + +
    + string +
    +     		always +
    Indicates the major engine version associated with this option group.
    +
    +
    Sample:
    +
    5.6
    +
    +
    + option_group_arn + +
    + string +
    +     		always +
    The Amazon Resource Name (ARN) for the option group.
    +
    +
    Sample:
    +
    arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group
    +
    +
    + option_group_description + +
    + string +
    +     		always +
    Provides a description of the option group.
    +
    +
    Sample:
    +
    test mysql option group
    +
    +
    + option_group_name + +
    + string +
    +     		always +
    Specifies the name of the option group.
    +
    +
    Sample:
    +
    test-mysql-option-group
    +
    +
    + options + +
    + list + / elements=dictionary +
    +     		always +
    Indicates what options are available in the option group.
    +
    +
      +
    + db_security_group_memberships + +
    + list + / elements=dictionary +
    +     		always +
    If the option requires access to a port, then this DB security group allows access to the port.
    +
    +
       +
    + db_security_group_name + +
    + string +
    +     		always +
    The name of the DB security group.
    +
    +
    Sample:
    +
    mydbsecuritygroup
    +
       +
    + status + +
    + string +
    +     		always +
    The status of the DB security group.
    +
    +
    Sample:
    +
    available
    +
      +
    + option_description + +
    + string +
    +     		always +
    The description of the option.
    +
    +
    Sample:
    +
    Innodb Memcached for MySQL
    +
      +
    + option_name + +
    + string +
    +     		always +
    The name of the option.
    +
    +
    Sample:
    +
    MEMCACHED
    +
      +
    + option_settings + +
    + list +
    +     		always +
    The name of the option.
    +
    +
       +
    + allowed_values + +
    + string +
    +     		always +
    The allowed values of the option setting.
    +
    +
    Sample:
    +
    1-2048
    +
       +
    + apply_type + +
    + string +
    +     		always +
    The DB engine specific parameter type.
    +
    +
    Sample:
    +
    STATIC
    +
       +
    + data_type + +
    + string +
    +     		always +
    The data type of the option setting.
    +
    +
    Sample:
    +
    INTEGER
    +
       +
    + default_value + +
    + string +
    +     		always +
    The default value of the option setting.
    +
    +
    Sample:
    +
    1024
    +
       +
    + description + +
    + string +
    +     		always +
    The description of the option setting.
    +
    +
    Sample:
    +
    Verbose level for memcached.
    +
       +
    + is_collection + +
    + boolean +
    +     		always +
    Indicates if the option setting is part of a collection.
    +
    +
    Sample:
    +
    True
    +
       +
    + is_modifiable + +
    + boolean +
    +     		always +
    A Boolean value that, when true, indicates the option setting can be modified from the default.
    +
    +
    Sample:
    +
    True
    +
       +
    + name + +
    + string +
    +     		always +
    The name of the option that has settings that you can set.
    +
    +
    Sample:
    +
    INNODB_API_ENABLE_MDL
    +
       +
    + value + +
    + string +
    +     		always +
    The current value of the option setting.
    +
    +
    Sample:
    +
    0
    +
      +
    + permanent + +
    + boolean +
    +     		always +
    Indicate if this option is permanent.
    +
    +
    Sample:
    +
    True
    +
      +
    + persistent + +
    + boolean +
    +     		always +
    Indicate if this option is persistent.
    +
    +
    Sample:
    +
    True
    +
      +
    + port + +
    + integer +
    +     		always +
    If required, the port configured for this option to use.
    +
    +
    Sample:
    +
    11211
    +
      +
    + vpc_security_group_memberships + +
    + list + / elements=dictionary +
    +     		always +
    If the option requires access to a port, then this VPC security group allows access to the port.
    +
    +
       +
    + status + +
    + string +
    +     		always +
    The status of the VPC security group.
    +
    +
    Sample:
    +
    available
    +
       +
    + vpc_security_group_id + +
    + string +
    +     		always +
    The name of the VPC security group.
    +
    +
    Sample:
    +
    sg-0cd636a23ae76e9a4
    +
    +
    + tags + +
    + dictionary +
    +     		always +
    The tags associated the Internet Gateway.
    +
    +
    Sample:
    +
    {'Ansible': 'Test'}
    +
    +
    + vpc_id + +
    + string +
    +     		always +
    If present, this option group can only be applied to instances that are in the VPC indicated by this field.
    +
    +
    Sample:
    +
    vpc-bf07e9d6
    +
    +

    + + +Status +------ + + +Authors +~~~~~~~ + +- Nick Aslanidis (@naslanidis) +- Will Thames (@willthames) +- Alina Buzachis (@alinabuzachis) diff --git a/docs/community.aws.rds_subnet_group_module.rst b/docs/community.aws.rds_subnet_group_module.rst index 2618eb29a14..f981bca5846 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates, modifies, and deletes RDS database subnet groups. This module has a dependency on python-boto >= 2.5. +- Creates, modifies, and deletes RDS database subnet groups. diff --git a/docs/community.aws.redshift_subnet_group_module.rst b/docs/community.aws.redshift_subnet_group_module.rst index b007c1e9934..9cd895d9409 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -25,10 +25,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 +- python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 -- python >= 3.6 Parameters @@ -134,7 +133,7 @@ Parameters
    - ec2_url + description
    string @@ -143,14 +142,14 @@ Parameters -
    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
    +
    Cluster subnet group description.
    +

    aliases: group_description
    - group_description + ec2_url
    string @@ -159,15 +158,14 @@ Parameters -
    Database subnet group description.
    -
    Required when state=present.
    -

    aliases: description
    +
    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
    - group_name + name
    string @@ -178,25 +176,7 @@ Parameters
    Cluster subnet group name.
    -

    aliases: name
    - - - - -
    - group_subnets - -
    - list - / elements=string -
    - - - - -
    List of subnet IDs that make up the cluster subnet group.
    -
    Required when state=present.
    -

    aliases: subnets
    +

    aliases: group_name
    @@ -257,17 +237,34 @@ Parameters
    string - / required
      Choices: -
    • present
      • +
    • present ←
    • absent
    -
    Specifies whether the subnet should be present or absent.
    +
    Specifies whether the subnet group should be present or absent.
    + + + + +
    + subnets + +
    + list + / elements=string +
    + + + + +
    List of subnet IDs that make up the cluster subnet group.
    +
    At least one subnet must be provided when creating a cluster subnet group.
    +

    aliases: group_subnets
    @@ -340,20 +337,38 @@ Common return values are documented `here
    - group + cluster_subnet_group
    - complex + dictionary
    success -
    dictionary containing all Redshift subnet group information
    +
    A dictionary containing information about the Redshift subnet group.

      + +
    + description + +
    + string +
    + + when the cache subnet group exists + +
    The description of the cache subnet group.
    +
    +
    Sample:
    +
    Redshift subnet
    + + + +  
    name @@ -362,14 +377,33 @@ Common return values are documented `here string
    - success + when the cache subnet group exists -
    name of the Redshift subnet group
    +
    Name of the Redshift subnet group.

    Sample:
    redshift_subnet_group_name
    + +   + +
    + subnet_ids + +
    + list + / elements=string +
    + + when the cache subnet group exists + +
    The IDs of the subnets beloging to the Redshift subnet group.
    +
    +
    Sample:
    +
    ['subnet-aaaaaaaa', 'subnet-bbbbbbbb']
    + +   @@ -380,9 +414,9 @@ Common return values are documented `here string
    - success + when the cache subnet group exists -
    Id of the VPC where the subnet is located
    +
    Id of the VPC where the subnet is located.

    Sample:
    vpc-aabb1122
    diff --git a/docs/community.aws.route53_health_check_module.rst b/docs/community.aws.route53_health_check_module.rst index 3d29ebeb929..4b6c8fc96ea 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -5,7 +5,7 @@ community.aws.route53_health_check ********************************** -**Add or delete health-checks in Amazons Route53 DNS service** +**Manage health-checks in Amazons Route53 DNS service** Version added: 1.0.0 @@ -26,10 +26,9 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- boto >= 2.49.0 +- python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 -- python >= 3.6 Parameters @@ -132,6 +131,28 @@ Parameters
    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.
    + + +
    + disabled + +
    + boolean +
    +
    added in 2.1.0
    + + +
      Choices: +
    • no
      • +
    • yes
      • +
    + + +
    Stops Route 53 from performing health checks.
    +
    See the AWS documentation for more details on the exact implications. https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-values.html
    +
    Defaults to true when creating a new health check.
    + +
    @@ -161,7 +182,7 @@ Parameters
      Choices:
    • 1
    • 2
      • -
    • 3 ←
      • +
    • 3
    • 4
    • 5
    • 6
      • @@ -173,6 +194,7 @@ Parameters
      The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
      +
      Will default to 3 if not specified on creation.
      @@ -203,6 +225,7 @@ Parameters
      IP address of the end-point to check. Either this or fqdn has to be provided.
      +
      IP addresses must be publicly routable.
      @@ -237,6 +260,26 @@ Parameters

      aliases: aws_profile
      + + +
      + purge_tags + +
      + boolean +
      +
      added in 2.1.0
      + + +
        Choices: +
      • no ←
        • +
      • yes
        • +
      + + +
      Delete any tags not specified in tags.
      + +
      @@ -285,7 +328,7 @@ Parameters
      The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
      -
      Required for all checks except TCP.
      +
      Mutually exclusive with type='TCP'.
      The path must begin with a /
      Maximum 255 characters.
      @@ -342,6 +385,22 @@ Parameters
      If the check type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the first 5120 bytes of the response body, Amazon Route 53 considers the resource healthy.
      + + +
      + tags + +
      + dictionary +
      +
      added in 2.1.0
      + + + + +
      A hash/dictionary of tags to set on the health check.
      + +
      @@ -434,6 +493,294 @@ Examples +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      KeyReturnedDescription
      +
      + health_check + +
      + dictionary +
      +       		success +
      Information about the health check.
      +
      +
        +
      + action + +
      + string +
      +       		When a change is or would be made. +
      The action performed by the module.
      +
      +
      Sample:
      +
      updated
      +
        +
      + health_check_config + +
      + dictionary +
      +       		When the health check exists. +
      Detailed information about the health check.
      +
      May contain additional values from Route 53 health check features not yet supported by this module.
      +
      +
         +
      + disabled + +
      + boolean +
      +       		When the health check exists. +
      Whether the health check has been disabled or not.
      +
      +
         +
      + failure_threshold + +
      + integer +
      +       		When the health check exists. +
      The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
      +
      +
      Sample:
      +
      3
      +
         +
      + fully_qualified_domain_name + +
      + string +
      +       		When the health check exists and an FQDN is configured. +
      The FQDN configured for the health check to test.
      +
      +
      Sample:
      +
      updated
      +
         +
      + ip_address + +
      + string +
      +       		When the health check exists and a specific IP address is configured. +
      The IPv4 or IPv6 IP address of the endpoint to be queried.
      +
      +
         +
      + port + +
      + string +
      +       		When the health check exists. +
      The port on the endpoint that the health check will query.
      +
      +
      Sample:
      +
      updated
      +
         +
      + request_interval + +
      + integer +
      +       		When the health check exists. +
      The number of seconds between health check queries.
      +
      +
      Sample:
      +
      30
      +
         +
      + resource_path + +
      + string +
      +       		When the health check exists and a resource path has been configured. +
      The URI path to query when performing an HTTP/HTTPS based health check.
      +
      +
      Sample:
      +
      /healthz
      +
         +
      + search_string + +
      + string +
      +       		When the health check exists and a search string has been configured. +
      A string that must be present in the response for a health check to be considered successful.
      +
      +
      Sample:
      +
      ALIVE
      +
         +
      + type + +
      + string +
      +       		When the health check exists. +
      The type of the health check.
      +
      +
      Sample:
      +
      HTTPS_STR_MATCH
      +
        +
      + health_check_version + +
      + integer +
      +       		When the health check exists. +
      The version number of the health check.
      +
      +
      Sample:
      +
      14
      +
        +
      + id + +
      + string +
      +       		When the health check exists. +
      The Unique ID assigned by AWS to the health check.
      +
      +
      Sample:
      +
      50ec8a13-9623-4c66-9834-dd8c5aedc9ba
      +
        +
      + tags + +
      + dictionary +
      +       		When the health check exists. +
      A dictionary representing the tags on the health check.
      +
      +
      Sample:
      +
      {"my_key": "my_value"}
      +
      +

      + Status ------ diff --git a/docs/community.aws.route53_module.rst b/docs/community.aws.route53_module.rst index 47e58e06062..80f7049d985 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -409,7 +409,7 @@ Parameters
    -
    Specifies the state of the resource record. As of Ansible 2.4, the command option has been changed to state as default and the choices present and absent have been added, but command still works as well.
    +
    Specifies the state of the resource record.

    aliases: command
    diff --git a/docs/community.aws.route53_zone_module.rst b/docs/community.aws.route53_zone_module.rst index f80f0e2a9ac..a43dcbb9b73 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -211,6 +211,26 @@ Parameters

    aliases: aws_profile
    + + +
    + purge_tags + +
    + boolean +
    +
    added in 2.1.0
    + + +
      Choices: +
    • no ←
      • +
    • yes
      • +
    + + +
    Delete any tags not specified in the task that are on the zone. This means you have to specify all the desired tags on each task affecting a zone.
    + +
    @@ -264,6 +284,22 @@ Parameters
    Whether or not the zone should exist or not.
    + + +
    + tags + +
    + dictionary +
    +
    added in 2.1.0
    + + + + +
    A hash/dictionary of tags to add to the new instance or to add/remove from an existing one.
    + +
    @@ -372,6 +408,21 @@ Examples comment: reusable delegation set example delegation_set_id: A1BCDEF2GHIJKL + - name: create a public zone with tags + community.aws.route53_zone: + zone: example.com + comment: this is an example + tags: + Owner: Ansible Team + + - name: modify a public zone, removing all previous tags and adding a new one + community.aws.route53_zone: + zone: example.com + comment: this is an example + tags: + Support: Ansible Community + purge_tags: true + Return Values @@ -454,6 +505,21 @@ Common return values are documented `here True
    + + +
    + tags + +
    + dictionary +
    + + when tags are defined + +
    tags associated with the zone
    +
    + +
    diff --git a/docs/community.aws.sns_topic_module.rst b/docs/community.aws.sns_topic_module.rst index 321a1b958ec..d550bef0cb3 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -38,12 +38,12 @@ Parameters - + - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - +
    ParameterParameter Choices/Defaults Comments
    +
    aws_access_key @@ -61,7 +61,7 @@ Parameters
    +
    aws_ca_bundle @@ -78,7 +78,7 @@ Parameters
    +
    aws_config @@ -95,7 +95,7 @@ Parameters
    +
    aws_secret_key @@ -113,7 +113,7 @@ Parameters
    +
    debug_botocore_endpoint_logs @@ -132,7 +132,7 @@ Parameters
    +
    delivery_policy @@ -146,8 +146,243 @@ Parameters
    Delivery policy to apply to the SNS topic.
    +
    + http + +
    + dictionary +
    +     		+ +
    Delivery policy for HTTP(S) messages.
    + +
    +
    + defaultHealthyRetryPolicy + +
    + dictionary + / required +
    +     		+ +
    Retry policy for HTTP(S) messages.
    +
    +
    + backoffFunction + +
    + string + / required +
    +     		+
      Choices: +
    • arithmetic
      • +
    • exponential
      • +
    • geometric
      • +
    • linear
      • +
    +     		+
    The function for backoff between retries.
    +
    +
    + maxDelayTarget + +
    + integer + / required +
    +     		+ +
    The maximum delay for a retry.
    +
    +
    + minDelayTarget + +
    + integer + / required +
    +     		+ +
    The minimum delay for a retry.
    +
    +
    + numMaxDelayRetries + +
    + integer + / required +
    +     		+ +
    The number of retries with the maximum delay between them.
    +
    +
    + numMinDelayRetries + +
    + integer + / required +
    +     		+ +
    The number of retries with just the minimum delay between them.
    +
    +
    + numNoDelayRetries + +
    + integer + / required +
    +     		+ +
    The number of retries to be performmed immediately.
    +
    +
    + numRetries + +
    + integer + / required +
    +     		+ +
    The total number of retries.
    +
    +
    + defaultThrottlePolicy + +
    + dictionary +
    +     		+ +
    Throttle the rate of messages sent to subsriptions.
    +
    +
    + maxReceivesPerSecond + +
    + integer + / required +
    +     		+ +
    The maximum number of deliveries per second per subscription.
    +
    +
    + disableSubscriptionOverrides + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes
      • +
    +     		+
    Applies this policy to all subscriptions, even if they have their own policies.
    +
    display_name @@ -162,7 +397,7 @@ Parameters
    +
    ec2_url @@ -178,7 +413,7 @@ Parameters
    +
    name @@ -194,7 +429,7 @@ Parameters
    +
    policy @@ -209,7 +444,7 @@ Parameters
    +
    profile @@ -226,7 +461,7 @@ Parameters
    +
    purge_subscriptions @@ -245,7 +480,7 @@ Parameters
    +
    region @@ -261,7 +496,7 @@ Parameters
    +
    security_token @@ -279,7 +514,7 @@ Parameters
    +
    state @@ -298,7 +533,7 @@ Parameters
    +
    subscriptions @@ -316,7 +551,7 @@ Parameters
    +
    endpoint @@ -333,7 +568,7 @@ Parameters
    +
    protocol @@ -350,7 +585,7 @@ Parameters
    +
    topic_type @@ -370,7 +605,7 @@ Parameters
    +
    validate_certs diff --git a/docs/community.aws.sqs_queue_module.rst b/docs/community.aws.sqs_queue_module.rst index e32121739cb..347cf1f35fd 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -605,7 +605,7 @@ Common return values are documented `here string     		alwaysif value exists
    The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.

    diff --git a/galaxy.yml b/galaxy.yml index 52f221bf07a..95cee206cab 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 2.0.0 +version: 2.1.0 readme: README.md authors: - Ansible (https://github.com/ansible) @@ -8,7 +8,7 @@ description: null license_file: COPYING tags: [community, aws, cloud, amazon] dependencies: - amazon.aws: '>=2.0.0' + amazon.aws: '>=2.1.0' repository: https://github.com/ansible-collections/community.aws documentation: https://github.com/ansible-collections/community.aws/tree/main/docs homepage: https://github.com/ansible-collections/community.aws diff --git a/tests/requirements.yml b/tests/requirements.yml index 3480da42122..8038ae1d456 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 2.1.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 2.0.0 +- amazon.aws >= 2.1.0