diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7f88ea72945..54811a94b41 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,43 @@ community.aws Release Notes .. contents:: Topics +v1.3.0 +====== + +Minor Changes +------------- + +- ec2_vpc_igw - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). +- ec2_vpc_igw - Add ``purge_tags`` parameter so that tags can be added without purging existing tags to match the collection standard tagging behaviour (https://github.com/ansible-collections/community.aws/pull/318). +- ec2_vpc_igw_info - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). +- ec2_vpc_igw_info - Add ``convert_tags`` parameter so that tags can be returned in standard dict format rather than the both list of dict format (https://github.com/ansible-collections/community.aws/pull/318). +- rds_instance - set ``no_log=False`` on ``force_update_password`` to clear warning (https://github.com/ansible-collections/community.aws/issues/241). +- redshift - add support for setting tags. +- s3_lifecycle - Add support for intelligent tiering and deep archive storage classes (https://github.com/ansible-collections/community.aws/issues/270) + +Deprecated Features +------------------- + +- ec2_vpc_igw_info - After 2022-06-22 the ``convert_tags`` parameter default value will change from ``False`` to ``True`` to match the collection standard behavior (https://github.com/ansible-collections/community.aws/pull/318). + +Bugfixes +-------- + +- aws_kms_info - fixed incompatibility with external and custom key-store keys. The module was attempting to call `GetKeyRotationStatus`, which raises `UnsupportedOperationException` for these key types (https://github.com/ansible-collections/community.aws/pull/311). +- ec2_win_password - on success return state as not changed (https://github.com/ansible-collections/community.aws/issues/145) +- ec2_win_password - return failed if unable to decode the password (https://github.com/ansible-collections/community.aws/issues/142) +- ecs_service - fix element type for ``load_balancers`` parameter (https://github.com/ansible-collections/community.aws/issues/265). +- ecs_taskdefinition - fixes elements type for ``containers`` parameter (https://github.com/ansible-collections/community.aws/issues/264). +- iam_policy - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). +- iam_policy_info - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). +- kinesis_stream - fixes issue where kinesis streams with > 100 shards get stuck in an infinite loop (https://github.com/ansible-collections/community.aws/pull/93) +- s3_sync - fix chunk_size calculation (https://github.com/ansible-collections/community.aws/issues/272) + +New Modules +----------- + +- s3_metrics_configuration - Manage s3 bucket metrics configuration in AWS + v1.2.1 ====== diff --git a/README.md b/README.md index f5f19b2aaaf..d4b93c36e6b 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Name | Description [community.aws.elasticache_parameter_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_parameter_group_module.rst)|Manage cache parameter groups in Amazon ElastiCache. [community.aws.elasticache_snapshot](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_snapshot_module.rst)|Manage cache snapshots in Amazon ElastiCache [community.aws.elasticache_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_subnet_group_module.rst)|manage ElastiCache subnet groups -[community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application load balancer +[community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application Load Balancer [community.aws.elb_application_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_info_module.rst)|Gather information about application ELBs in AWS [community.aws.elb_classic_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_module.rst)|Creates or destroys Amazon ELB. [community.aws.elb_classic_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS @@ -189,18 +189,19 @@ Name | Description [community.aws.redshift_cross_region_snapshots](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.redshift_cross_region_snapshots_module.rst)|Manage Redshift Cross Region Snapshots [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 Route53 DNS service +[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_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 [community.aws.s3_lifecycle](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_lifecycle_module.rst)|Manage s3 bucket lifecycle rules in AWS [community.aws.s3_logging](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_logging_module.rst)|Manage logging facility of an s3 bucket in AWS +[community.aws.s3_metrics_configuration](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_metrics_configuration_module.rst)|Manage s3 bucket metrics configuration in AWS [community.aws.s3_sync](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_sync_module.rst)|Efficiently upload multiple files to S3 [community.aws.s3_website](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_website_module.rst)|Configure an s3 bucket as a website [community.aws.sns](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_module.rst)|Send Amazon Simple Notification Service messages [community.aws.sns_topic](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_topic_module.rst)|Manages AWS SNS topics and subscriptions -[community.aws.sqs_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sqs_queue_module.rst)|Creates or deletes AWS SQS queues. +[community.aws.sqs_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sqs_queue_module.rst)|Creates or deletes AWS SQS queues [community.aws.sts_assume_role](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sts_assume_role_module.rst)|Assume a role using AWS Security Token Service and obtain temporary credentials [community.aws.sts_session_token](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sts_session_token_module.rst)|Obtain a session token from the AWS Security Token Service diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index d42c71fe91a..25102ab8cc6 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -754,3 +754,51 @@ releases: - 234-fix_ssm_inventory_plugin_timeout_var.yaml - 25-add-sts-token-to-aws-ssm-conn-plugin.yaml release_date: '2020-10-07' + 1.3.0: + changes: + bugfixes: + - aws_kms_info - fixed incompatibility with external and custom key-store keys. + The module was attempting to call `GetKeyRotationStatus`, which raises `UnsupportedOperationException` + for these key types (https://github.com/ansible-collections/community.aws/pull/311). + - ec2_win_password - on success return state as not changed (https://github.com/ansible-collections/community.aws/issues/145) + - ec2_win_password - return failed if unable to decode the password (https://github.com/ansible-collections/community.aws/issues/142) + - ecs_service - fix element type for ``load_balancers`` parameter (https://github.com/ansible-collections/community.aws/issues/265). + - ecs_taskdefinition - fixes elements type for ``containers`` parameter (https://github.com/ansible-collections/community.aws/issues/264). + - iam_policy - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). + - iam_policy_info - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). + - kinesis_stream - fixes issue where kinesis streams with > 100 shards get stuck + in an infinite loop (https://github.com/ansible-collections/community.aws/pull/93) + - s3_sync - fix chunk_size calculation (https://github.com/ansible-collections/community.aws/issues/272) + deprecated_features: + - ec2_vpc_igw_info - After 2022-06-22 the ``convert_tags`` parameter default + value will change from ``False`` to ``True`` to match the collection standard + behavior (https://github.com/ansible-collections/community.aws/pull/318). + minor_changes: + - ec2_vpc_igw - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). + - ec2_vpc_igw - Add ``purge_tags`` parameter so that tags can be added without + purging existing tags to match the collection standard tagging behaviour (https://github.com/ansible-collections/community.aws/pull/318). + - ec2_vpc_igw_info - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). + - ec2_vpc_igw_info - Add ``convert_tags`` parameter so that tags can be returned + in standard dict format rather than the both list of dict format (https://github.com/ansible-collections/community.aws/pull/318). + - rds_instance - set ``no_log=False`` on ``force_update_password`` to clear + warning (https://github.com/ansible-collections/community.aws/issues/241). + - redshift - add support for setting tags. + - s3_lifecycle - Add support for intelligent tiering and deep archive storage + classes (https://github.com/ansible-collections/community.aws/issues/270) + fragments: + - 244-rds_instance-no_log.yml + - 264-fix-elemt-type-for-containers-in-ecs_taskdefinition.yml + - 265-fix-element-type-ecs_service.yml + - 270_add_additional_storage_classes_to_S3_lifecycle_transition_list.yml + - 273-fix-s3sync-etag-calculation.yaml + - 283-fixed-ec2_win_password-return-state.yaml + - 311-fix-aws_kms_info-external-keys.yaml + - 318-cleanup-vpc_igw.yml + - 324-add-jittered-backoff-to-iam_policy-modules.yaml + - 34-redshift-tags.yml + - 93-kinesis_stream-get-more-shards-resolve.yml + modules: + - description: Manage s3 bucket metrics configuration in AWS + name: s3_metrics_configuration + namespace: '' + release_date: '2020-12-10' diff --git a/changelogs/fragments/244-rds_instance-no_log.yml b/changelogs/fragments/244-rds_instance-no_log.yml deleted file mode 100644 index 3acb6f863fc..00000000000 --- a/changelogs/fragments/244-rds_instance-no_log.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- rds_instance - set ``no_log=False`` on ``force_update_password`` to clear warning (https://github.com/ansible-collections/community.aws/issues/241). diff --git a/changelogs/fragments/264-fix-elemt-type-for-containers-in-ecs_taskdefinition.yml b/changelogs/fragments/264-fix-elemt-type-for-containers-in-ecs_taskdefinition.yml deleted file mode 100644 index b68ffff4f4e..00000000000 --- a/changelogs/fragments/264-fix-elemt-type-for-containers-in-ecs_taskdefinition.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - ecs_taskdefinition - fixes elements type for ``containers`` parameter (https://github.com/ansible-collections/community.aws/issues/264). diff --git a/changelogs/fragments/265-fix-element-type-ecs_service.yml b/changelogs/fragments/265-fix-element-type-ecs_service.yml deleted file mode 100644 index 61bbd20a8ce..00000000000 --- a/changelogs/fragments/265-fix-element-type-ecs_service.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - ecs_service - fix element type for ``load_balancers`` parameter (https://github.com/ansible-collections/community.aws/issues/265). diff --git a/changelogs/fragments/270_add_additional_storage_classes_to_S3_lifecycle_transition_list.yml b/changelogs/fragments/270_add_additional_storage_classes_to_S3_lifecycle_transition_list.yml deleted file mode 100644 index ac1d6306704..00000000000 --- a/changelogs/fragments/270_add_additional_storage_classes_to_S3_lifecycle_transition_list.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - s3_lifecycle - Add support for intelligent tiering and deep archive storage classes (https://github.com/ansible-collections/community.aws/issues/270) diff --git a/changelogs/fragments/273-fix-s3sync-etag-calculation.yaml b/changelogs/fragments/273-fix-s3sync-etag-calculation.yaml deleted file mode 100644 index bd408c87efa..00000000000 --- a/changelogs/fragments/273-fix-s3sync-etag-calculation.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - s3_sync - fix chunk_size calculation (https://github.com/ansible-collections/community.aws/issues/272) diff --git a/changelogs/fragments/283-fixed-ec2_win_password-return-state.yaml b/changelogs/fragments/283-fixed-ec2_win_password-return-state.yaml deleted file mode 100644 index bacacd603bb..00000000000 --- a/changelogs/fragments/283-fixed-ec2_win_password-return-state.yaml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: - - ec2_win_password - return failed if unable to decode the password (https://github.com/ansible-collections/community.aws/issues/142) - - ec2_win_password - on success return state as not changed (https://github.com/ansible-collections/community.aws/issues/145) \ No newline at end of file diff --git a/changelogs/fragments/311-fix-aws_kms_info-external-keys.yaml b/changelogs/fragments/311-fix-aws_kms_info-external-keys.yaml deleted file mode 100644 index 618023c35ee..00000000000 --- a/changelogs/fragments/311-fix-aws_kms_info-external-keys.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - aws_kms_info - fixed incompatibility with external and custom key-store keys. The module was attempting to call `GetKeyRotationStatus`, which raises `UnsupportedOperationException` for these key types (https://github.com/ansible-collections/community.aws/pull/311). diff --git a/changelogs/fragments/318-cleanup-vpc_igw.yml b/changelogs/fragments/318-cleanup-vpc_igw.yml deleted file mode 100644 index 58dc4f50ea0..00000000000 --- a/changelogs/fragments/318-cleanup-vpc_igw.yml +++ /dev/null @@ -1,7 +0,0 @@ -minor_changes: -- ec2_vpc_igw - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). -- ec2_vpc_igw_info - Add AWSRetry decorators to improve reliability (https://github.com/ansible-collections/community.aws/pull/318). -- ec2_vpc_igw - Add ``purge_tags`` parameter so that tags can be added without purging existing tags to match the collection standard tagging behaviour (https://github.com/ansible-collections/community.aws/pull/318). -- ec2_vpc_igw_info - Add ``convert_tags`` parameter so that tags can be returned in standard dict format rather than the both list of dict format (https://github.com/ansible-collections/community.aws/pull/318). -deprecated_features: -- ec2_vpc_igw_info - After 2022-06-22 the ``convert_tags`` parameter default value will change from ``False`` to ``True`` to match the collection standard behavior (https://github.com/ansible-collections/community.aws/pull/318). diff --git a/changelogs/fragments/324-add-jittered-backoff-to-iam_policy-modules.yaml b/changelogs/fragments/324-add-jittered-backoff-to-iam_policy-modules.yaml deleted file mode 100644 index 9dd457abba4..00000000000 --- a/changelogs/fragments/324-add-jittered-backoff-to-iam_policy-modules.yaml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: - - iam_policy - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). - - iam_policy_info - Added jittered_backoff to handle AWS rate limiting (https://github.com/ansible-collections/community.aws/pull/324). diff --git a/changelogs/fragments/34-redshift-tags.yml b/changelogs/fragments/34-redshift-tags.yml deleted file mode 100644 index 86d817e97e4..00000000000 --- a/changelogs/fragments/34-redshift-tags.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- redshift - add support for setting tags. diff --git a/changelogs/fragments/93-kinesis_stream-get-more-shards-resolve.yml b/changelogs/fragments/93-kinesis_stream-get-more-shards-resolve.yml deleted file mode 100644 index 84365d6ff15..00000000000 --- a/changelogs/fragments/93-kinesis_stream-get-more-shards-resolve.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: -- kinesis_stream - fixes issue where kinesis streams with > 100 shards get stuck in an infinite loop (https://github.com/ansible-collections/community.aws/pull/93) diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.aws_acm_info_module.rst index 01527f459d0..45d16ff9e5e 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.aws_acm_info_module.rst @@ -310,7 +310,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: obtain all ACM certificates community.aws.aws_acm_info: diff --git a/docs/community.aws.aws_acm_module.rst b/docs/community.aws.aws_acm_module.rst index 5a0ac96dc79..b18479194d3 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.aws_acm_module.rst @@ -381,7 +381,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: upload a self-signed certificate community.aws.aws_acm: diff --git a/docs/community.aws.aws_api_gateway_module.rst b/docs/community.aws.aws_api_gateway_module.rst index c8b19465013..f1505078c9a 100644 --- a/docs/community.aws.aws_api_gateway_module.rst +++ b/docs/community.aws.aws_api_gateway_module.rst @@ -17,9 +17,9 @@ Version added: 1.0.0 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 create 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 with your AWS rep. +- 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. @@ -145,7 +145,7 @@ Parameters -
Enable API GW caching of backend responses. Defaults to false.
+
Enable API GW caching of backend responses.
@@ -205,7 +205,8 @@ Parameters Default:
"Automatic deployment by Ansible."
-
Description of the deployment - recorded and visible in the AWS console.
+
Description of the deployment.
+
Recorded and visible in the AWS console.
@@ -241,9 +242,9 @@ Parameters -
Type of endpoint configuration, use EDGE for an edge optimized API endpoint,
-
REGIONAL for just a regional deploy or PRIVATE for a private API.
-
This will flag will only be used when creating a new API Gateway setup, not for updates.
+
Type of endpoint configuration.
+
Use EDGE for an edge optimized API endpoint, REGIONAL for just a regional deploy or PRIVATE for a private API.
+
This flag will only be used when creating a new API Gateway setup, not for updates.
@@ -327,10 +328,10 @@ Parameters
Canary settings for the deployment of the stage.
Dict with following settings:
-
percentTraffic: The percent (0-100) of traffic diverted to a canary deployment.
-
deploymentId: The ID of the canary deployment.
-
stageVariableOverrides: Stage variables overridden for a canary release deployment.
-
useStageCache: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
+
percentTraffic: The percent (0-100) of traffic diverted to a canary deployment.
+
deploymentId: The ID of the canary deployment.
+
stageVariableOverrides: Stage variables overridden for a canary release deployment.
+
useStageCache: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
See docs https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway.Client.create_stage
@@ -395,7 +396,7 @@ Parameters -
JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.
+
JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.

aliases: src, api_file
@@ -425,7 +426,7 @@ Parameters @@ -460,7 +461,7 @@ Notes ----- .. note:: - - A future version of this module will probably use tags or another ID so that an API can be create only once. + - A future version of this module will probably use tags or another ID so that an API can be created only once. - As an early work around an intermediate version will probably do the same using a tag embedded in the API name. - 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`` - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html @@ -471,7 +472,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Setup AWS API Gateway setup on AWS and deploy API definition community.aws.aws_api_gateway: diff --git a/docs/community.aws.aws_application_scaling_policy_module.rst b/docs/community.aws.aws_application_scaling_policy_module.rst index 8fc9b7307b2..8afeaa0e24a 100644 --- a/docs/community.aws.aws_application_scaling_policy_module.rst +++ b/docs/community.aws.aws_application_scaling_policy_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates, updates or removes a Scaling Policy +- Creates, updates or removes a Scaling Policy. @@ -189,12 +189,13 @@ Parameters
Whether or not to override values of minimum and/or maximum tasks if it's already set.
+
Defaults to false.
@@ -367,7 +368,7 @@ Parameters -
Whether a policy should be present or absent
+
Whether a policy should be present or absent.
@@ -382,7 +383,7 @@ Parameters -
A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.
+
A step scaling policy. This parameter is required if you are creating a policy and policy_type=StepScaling.
@@ -397,7 +398,7 @@ Parameters -
A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.
+
A target tracking policy. This parameter is required if you are creating a new policy and policy_type=TargetTrackingScaling.
Full documentation of the suboptions can be found in the API documentation:
https://docs.aws.amazon.com/autoscaling/application/APIReference/API_TargetTrackingScalingPolicyConfiguration.html
@@ -499,7 +500,7 @@ Parameters -
The target value for the metric
+
The target value for the metric.
@@ -540,7 +541,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_batch_compute_environment_module.rst b/docs/community.aws.aws_batch_compute_environment_module.rst index b280808e998..01271a753d9 100644 --- a/docs/community.aws.aws_batch_compute_environment_module.rst +++ b/docs/community.aws.aws_batch_compute_environment_module.rst @@ -538,7 +538,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: My Batch Compute Environment community.aws.aws_batch_compute_environment: diff --git a/docs/community.aws.aws_batch_job_definition_module.rst b/docs/community.aws.aws_batch_job_definition_module.rst index 4e151ca1de1..4b821215793 100644 --- a/docs/community.aws.aws_batch_job_definition_module.rst +++ b/docs/community.aws.aws_batch_job_definition_module.rst @@ -684,7 +684,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- - hosts: localhost diff --git a/docs/community.aws.aws_batch_job_queue_module.rst b/docs/community.aws.aws_batch_job_queue_module.rst index 700a240b99c..8fffc6d6d0d 100644 --- a/docs/community.aws.aws_batch_job_queue_module.rst +++ b/docs/community.aws.aws_batch_job_queue_module.rst @@ -356,7 +356,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: My Batch Job Queue community.aws.aws_batch_job_queue: diff --git a/docs/community.aws.aws_codebuild_module.rst b/docs/community.aws.aws_codebuild_module.rst index 113984f2af1..225a721095f 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -766,7 +766,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_codecommit_module.rst b/docs/community.aws.aws_codecommit_module.rst index c99a8d6d4fd..37f2d3bfe65 100644 --- a/docs/community.aws.aws_codecommit_module.rst +++ b/docs/community.aws.aws_codecommit_module.rst @@ -288,7 +288,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create a new repository - community.aws.aws_codecommit: diff --git a/docs/community.aws.aws_codepipeline_module.rst b/docs/community.aws.aws_codepipeline_module.rst index 807b7d38626..7dc4353b821 100644 --- a/docs/community.aws.aws_codepipeline_module.rst +++ b/docs/community.aws.aws_codepipeline_module.rst @@ -404,7 +404,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_config_aggregation_authorization_module.rst b/docs/community.aws.aws_config_aggregation_authorization_module.rst index e864f003df8..6fccefcc774 100644 --- a/docs/community.aws.aws_config_aggregation_authorization_module.rst +++ b/docs/community.aws.aws_config_aggregation_authorization_module.rst @@ -286,7 +286,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Get current account ID community.aws.aws_caller_info: diff --git a/docs/community.aws.aws_config_aggregator_module.rst b/docs/community.aws.aws_config_aggregator_module.rst index 129f99b2ed7..174310c5eab 100644 --- a/docs/community.aws.aws_config_aggregator_module.rst +++ b/docs/community.aws.aws_config_aggregator_module.rst @@ -412,7 +412,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create cross-account aggregator community.aws.aws_config_aggregator: diff --git a/docs/community.aws.aws_config_delivery_channel_module.rst b/docs/community.aws.aws_config_delivery_channel_module.rst index 9b4ecccb2db..be94d2f101a 100644 --- a/docs/community.aws.aws_config_delivery_channel_module.rst +++ b/docs/community.aws.aws_config_delivery_channel_module.rst @@ -338,7 +338,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create Delivery Channel for AWS Config community.aws.aws_config_delivery_channel: diff --git a/docs/community.aws.aws_config_recorder_module.rst b/docs/community.aws.aws_config_recorder_module.rst index 88e2a320de5..74132eb51ad 100644 --- a/docs/community.aws.aws_config_recorder_module.rst +++ b/docs/community.aws.aws_config_recorder_module.rst @@ -357,7 +357,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create Configuration Recorder for AWS Config community.aws.aws_config_recorder: diff --git a/docs/community.aws.aws_config_rule_module.rst b/docs/community.aws.aws_config_rule_module.rst index 68a63f10445..d33a4f33334 100644 --- a/docs/community.aws.aws_config_rule_module.rst +++ b/docs/community.aws.aws_config_rule_module.rst @@ -471,7 +471,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create Config Rule for AWS Config community.aws.aws_config_rule: diff --git a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst index 6b7cbd7617e..b105b278bbf 100644 --- a/docs/community.aws.aws_direct_connect_confirm_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_confirm_connection_module.rst @@ -268,7 +268,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # confirm a Direct Connect by name - name: confirm the connection id diff --git a/docs/community.aws.aws_direct_connect_connection_module.rst b/docs/community.aws.aws_direct_connect_connection_module.rst index b5144c71813..10bf85bb695 100644 --- a/docs/community.aws.aws_direct_connect_connection_module.rst +++ b/docs/community.aws.aws_direct_connect_connection_module.rst @@ -195,12 +195,13 @@ Parameters -
To modify bandwidth or location the connection will need to be deleted and recreated. By default this will not happen - this option must be set to True.
+
To modify bandwidth or location the connection needs to be deleted and recreated.
+
By default this will not happen. This option must be explicitly set to true to change bandwith or location.
@@ -359,7 +360,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # create a Direct Connect connection - community.aws.aws_direct_connect_connection: @@ -383,7 +384,7 @@ Examples name: ansible-test-connection location: EqDC2 bandwidth: 10Gbps - forced_update: True + forced_update: true # delete the connection - community.aws.aws_direct_connect_connection: diff --git a/docs/community.aws.aws_direct_connect_gateway_module.rst b/docs/community.aws.aws_direct_connect_gateway_module.rst index fb8c2dc052b..6e4a37bd3ae 100644 --- a/docs/community.aws.aws_direct_connect_gateway_module.rst +++ b/docs/community.aws.aws_direct_connect_gateway_module.rst @@ -335,7 +335,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a new direct connect gateway attached to virtual private gateway community.aws.aws_direct_connect_gateway: diff --git a/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst b/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst index 3ccba0b5fc9..0aafe21240d 100644 --- a/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst +++ b/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst @@ -172,7 +172,7 @@ Parameters @@ -207,7 +207,7 @@ Parameters @@ -392,7 +392,7 @@ Parameters @@ -435,7 +435,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # create a Direct Connect connection - community.aws.aws_direct_connect_link_aggregation_group: diff --git a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst index 01cda9b0587..c959826cbce 100644 --- a/docs/community.aws.aws_direct_connect_virtual_interface_module.rst +++ b/docs/community.aws.aws_direct_connect_virtual_interface_module.rst @@ -461,7 +461,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- - name: create an association between a LAG and connection diff --git a/docs/community.aws.aws_eks_cluster_module.rst b/docs/community.aws.aws_eks_cluster_module.rst index 52a13fe9642..6a4e1be3b1c 100644 --- a/docs/community.aws.aws_eks_cluster_module.rst +++ b/docs/community.aws.aws_eks_cluster_module.rst @@ -367,7 +367,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_elasticbeanstalk_app_module.rst b/docs/community.aws.aws_elasticbeanstalk_app_module.rst index 1701e846825..5ce6e64dd8d 100644 --- a/docs/community.aws.aws_elasticbeanstalk_app_module.rst +++ b/docs/community.aws.aws_elasticbeanstalk_app_module.rst @@ -302,7 +302,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create or update an application - community.aws.aws_elasticbeanstalk_app: diff --git a/docs/community.aws.aws_glue_connection_module.rst b/docs/community.aws.aws_glue_connection_module.rst index 3980d4fdf83..1222fc1a9c8 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.aws_glue_connection_module.rst @@ -382,7 +382,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_glue_job_module.rst b/docs/community.aws.aws_glue_job_module.rst index 56dd091dbcc..fa81138ac0a 100644 --- a/docs/community.aws.aws_glue_job_module.rst +++ b/docs/community.aws.aws_glue_job_module.rst @@ -424,7 +424,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_inspector_target_module.rst b/docs/community.aws.aws_inspector_target_module.rst index bb8e5cfb35b..19d4cda8e15 100644 --- a/docs/community.aws.aws_inspector_target_module.rst +++ b/docs/community.aws.aws_inspector_target_module.rst @@ -286,7 +286,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create my_target Assessment Target community.aws.aws_inspector_target: diff --git a/docs/community.aws.aws_kms_info_module.rst b/docs/community.aws.aws_kms_info_module.rst index d40ded1373d..c8a33762150 100644 --- a/docs/community.aws.aws_kms_info_module.rst +++ b/docs/community.aws.aws_kms_info_module.rst @@ -268,7 +268,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_kms_module.rst b/docs/community.aws.aws_kms_module.rst index f5372c760ab..aee2ec1068d 100644 --- a/docs/community.aws.aws_kms_module.rst +++ b/docs/community.aws.aws_kms_module.rst @@ -609,7 +609,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Managing the KMS IAM Policy via policy_mode and policy_grant_types is fragile # and has been deprecated in favour of the policy option. diff --git a/docs/community.aws.aws_region_info_module.rst b/docs/community.aws.aws_region_info_module.rst index 344c84cc87f..dce1b7e7fe0 100644 --- a/docs/community.aws.aws_region_info_module.rst +++ b/docs/community.aws.aws_region_info_module.rst @@ -257,7 +257,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_s3_bucket_info_module.rst b/docs/community.aws.aws_s3_bucket_info_module.rst index b76abae9775..c06522686ec 100644 --- a/docs/community.aws.aws_s3_bucket_info_module.rst +++ b/docs/community.aws.aws_s3_bucket_info_module.rst @@ -235,7 +235,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_s3_cors_module.rst b/docs/community.aws.aws_s3_cors_module.rst index 7ba7f85729d..31f8b5bd7ad 100644 --- a/docs/community.aws.aws_s3_cors_module.rst +++ b/docs/community.aws.aws_s3_cors_module.rst @@ -285,7 +285,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_secret_module.rst b/docs/community.aws.aws_secret_module.rst index 8505e4f1691..9b72a3f31a4 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.aws_secret_module.rst @@ -399,7 +399,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Add string to AWS Secrets Manager community.aws.aws_secret: diff --git a/docs/community.aws.aws_ses_identity_module.rst b/docs/community.aws.aws_ses_identity_module.rst index 67a60de22aa..9cc37367205 100644 --- a/docs/community.aws.aws_ses_identity_module.rst +++ b/docs/community.aws.aws_ses_identity_module.rst @@ -459,7 +459,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_ses_identity_policy_module.rst b/docs/community.aws.aws_ses_identity_policy_module.rst index b3c9277026a..177b0f20617 100644 --- a/docs/community.aws.aws_ses_identity_policy_module.rst +++ b/docs/community.aws.aws_ses_identity_policy_module.rst @@ -303,7 +303,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_ses_rule_set_module.rst b/docs/community.aws.aws_ses_rule_set_module.rst index 7dc1b09cc2e..8734e4ccac3 100644 --- a/docs/community.aws.aws_ses_rule_set_module.rst +++ b/docs/community.aws.aws_ses_rule_set_module.rst @@ -311,7 +311,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.aws_sgw_info_module.rst b/docs/community.aws.aws_sgw_info_module.rst index 0e75bd134a2..00f665a0dab 100644 --- a/docs/community.aws.aws_sgw_info_module.rst +++ b/docs/community.aws.aws_sgw_info_module.rst @@ -311,7 +311,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.aws_ssm_connection.rst b/docs/community.aws.aws_ssm_connection.rst index fc8c364abea..63c2dfa2cbf 100644 --- a/docs/community.aws.aws_ssm_connection.rst +++ b/docs/community.aws.aws_ssm_connection.rst @@ -219,7 +219,7 @@ Parameters Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Stop Spooler Process on Windows Instances - name: Stop Spooler Service on Windows Instances diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.aws_ssm_parameter_store_module.rst index a0f653a9fe1..63994c7d5d5 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/docs/community.aws.aws_ssm_parameter_store_module.rst @@ -377,7 +377,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create or update key/value pair in aws parameter store community.aws.aws_ssm_parameter_store: diff --git a/docs/community.aws.aws_step_functions_state_machine_execution_module.rst b/docs/community.aws.aws_step_functions_state_machine_execution_module.rst index e8bd554f809..0e9159f0aca 100644 --- a/docs/community.aws.aws_step_functions_state_machine_execution_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_execution_module.rst @@ -345,7 +345,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Start an execution of a state machine community.aws.aws_step_functions_state_machine_execution: diff --git a/docs/community.aws.aws_step_functions_state_machine_module.rst b/docs/community.aws.aws_step_functions_state_machine_module.rst index f56bd56ad87..7a863fdcba0 100644 --- a/docs/community.aws.aws_step_functions_state_machine_module.rst +++ b/docs/community.aws.aws_step_functions_state_machine_module.rst @@ -335,7 +335,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create a new AWS Step Functions state machine - name: Setup HelloWorld state machine diff --git a/docs/community.aws.aws_waf_condition_module.rst b/docs/community.aws.aws_waf_condition_module.rst index 5c6fc396cdd..a22b1d2989d 100644 --- a/docs/community.aws.aws_waf_condition_module.rst +++ b/docs/community.aws.aws_waf_condition_module.rst @@ -594,7 +594,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create WAF byte condition community.aws.aws_waf_condition: diff --git a/docs/community.aws.aws_waf_info_module.rst b/docs/community.aws.aws_waf_info_module.rst index ee5162922a9..afc3aba03f5 100644 --- a/docs/community.aws.aws_waf_info_module.rst +++ b/docs/community.aws.aws_waf_info_module.rst @@ -269,7 +269,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: obtain all WAF information community.aws.aws_waf_info: diff --git a/docs/community.aws.aws_waf_rule_module.rst b/docs/community.aws.aws_waf_rule_module.rst index 2d818d5aa82..f0a3dee30c5 100644 --- a/docs/community.aws.aws_waf_rule_module.rst +++ b/docs/community.aws.aws_waf_rule_module.rst @@ -404,7 +404,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create WAF rule community.aws.aws_waf_rule: diff --git a/docs/community.aws.aws_waf_web_acl_module.rst b/docs/community.aws.aws_waf_web_acl_module.rst index a4ebfac329b..b6031af80c4 100644 --- a/docs/community.aws.aws_waf_web_acl_module.rst +++ b/docs/community.aws.aws_waf_web_acl_module.rst @@ -432,7 +432,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create web ACL community.aws.aws_waf_web_acl: diff --git a/docs/community.aws.cloudformation_exports_info_module.rst b/docs/community.aws.cloudformation_exports_info_module.rst index c98f1b87b50..8047723c9ed 100644 --- a/docs/community.aws.cloudformation_exports_info_module.rst +++ b/docs/community.aws.cloudformation_exports_info_module.rst @@ -234,7 +234,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Get Exports community.aws.cloudformation_exports_info: diff --git a/docs/community.aws.cloudformation_stack_set_module.rst b/docs/community.aws.cloudformation_stack_set_module.rst index 0758f018607..268c58f6106 100644 --- a/docs/community.aws.cloudformation_stack_set_module.rst +++ b/docs/community.aws.cloudformation_stack_set_module.rst @@ -606,7 +606,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a stack set with instances in two accounts community.aws.cloudformation_stack_set: diff --git a/docs/community.aws.cloudfront_distribution_module.rst b/docs/community.aws.cloudfront_distribution_module.rst index 4f70c08585e..7fe2ada6fa1 100644 --- a/docs/community.aws.cloudfront_distribution_module.rst +++ b/docs/community.aws.cloudfront_distribution_module.rst @@ -69,7 +69,7 @@ Parameters -
A list) of domain name aliases (CNAMEs) as strings to be used for the distribution.
+
A list of domain name aliases (CNAMEs) as strings to be used for the distribution.
Each alias must be unique across all distribution for the AWS account.
@@ -770,7 +770,7 @@ Parameters
A dict specifying the default cache behavior of the distribution.
-
If not specified, the target_origin_id is defined as the target_origin_id of the first valid cache_behavior in cache_behaviors with defaults.
+
If not specified, the target_origin_id is defined as the target_origin_id of the first valid cache_behavior in cache_behaviors with defaults.
@@ -1329,12 +1329,13 @@ Parameters
A boolean value that specifies whether the distribution is enabled or disabled.
+
Defaults to false.
@@ -1351,7 +1352,7 @@ Parameters
The version of the http protocol to use for the distribution.
AWS defaults this to http2.
-
Valid values are http1.1 and http2
+
Valid values are http1.1 and http2.
@@ -1365,12 +1366,13 @@ Parameters
Determines whether IPv6 support is enabled or not.
+
Defaults to false.
@@ -1492,7 +1494,7 @@ Parameters
Custom headers you wish to add to the request before passing it to the origin.
-
For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html
+
For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html.
@@ -1921,7 +1923,7 @@ Parameters
A list of ISO 3166-1 two letter (Alpha 2) country codes that the restriction should apply to.
-
See the ISO website for a full list of codes https://www.iso.org/obp/ui/#search/code/
+
See the ISO website for a full list of codes https://www.iso.org/obp/ui/#search/code/.
@@ -1939,7 +1941,7 @@ Parameters
The method that you want to use to restrict distribution of your content by country.
-
Valid values are none, whitelist, blacklist
+
Valid values are none, whitelist, blacklist.
@@ -1996,7 +1998,7 @@ Parameters
Should be input as a dict of key-value pairs.
-
Note that numeric keys or values must be wrapped in quotes. e.g. "Priority:" '1'
+
Note that numeric keys or values must be wrapped in quotes. e.g. Priority: '1'
@@ -2047,7 +2049,7 @@ Parameters
The ID of a certificate stored in ACM to use for HTTPS connections.
-
If acm_certificate_id is set then you must also specify ssl_support_method
+
If acm_certificate_id is set then you must also specify ssl_support_method.
@@ -2067,7 +2069,7 @@ Parameters -
If you're using the CloudFront domain name for your distribution, such as 123456789abcde.cloudfront.net you should set cloudfront_default_certificate=true
+
If you're using the CloudFront domain name for your distribution, such as 123456789abcde.cloudfront.net you should set cloudfront_default_certificate=true.
If cloudfront_default_certificate=true do not set ssl_support_method.
@@ -2085,7 +2087,7 @@ Parameters
The ID of a certificate stored in IAM to use for HTTPS connections.
-
If iam_certificate_id is set then you must also specify ssl_support_method
+
If iam_certificate_id is set then you must also specify ssl_support_method.
@@ -2190,7 +2192,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create a basic distribution with defaults and tags community.aws.cloudfront_distribution: diff --git a/docs/community.aws.cloudfront_info_module.rst b/docs/community.aws.cloudfront_info_module.rst index 7074801fb1e..3bc0915dd8d 100644 --- a/docs/community.aws.cloudfront_info_module.rst +++ b/docs/community.aws.cloudfront_info_module.rst @@ -573,7 +573,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.cloudfront_invalidation_module.rst b/docs/community.aws.cloudfront_invalidation_module.rst index b1b02e912a9..eef95720fe4 100644 --- a/docs/community.aws.cloudfront_invalidation_module.rst +++ b/docs/community.aws.cloudfront_invalidation_module.rst @@ -299,7 +299,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create a batch of invalidations using a distribution_id for a reference community.aws.cloudfront_invalidation: diff --git a/docs/community.aws.cloudfront_origin_access_identity_module.rst b/docs/community.aws.cloudfront_origin_access_identity_module.rst index 289f3ec9c44..69a2da9de57 100644 --- a/docs/community.aws.cloudfront_origin_access_identity_module.rst +++ b/docs/community.aws.cloudfront_origin_access_identity_module.rst @@ -299,7 +299,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create an origin access identity community.aws.cloudfront_origin_access_identity: diff --git a/docs/community.aws.cloudtrail_module.rst b/docs/community.aws.cloudtrail_module.rst index e7b031c8d9e..b124fa5915e 100644 --- a/docs/community.aws.cloudtrail_module.rst +++ b/docs/community.aws.cloudtrail_module.rst @@ -471,7 +471,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create single region cloudtrail community.aws.cloudtrail: diff --git a/docs/community.aws.cloudwatchevent_rule_module.rst b/docs/community.aws.cloudwatchevent_rule_module.rst index 70f28a0ccaa..ec1834b10d7 100644 --- a/docs/community.aws.cloudwatchevent_rule_module.rst +++ b/docs/community.aws.cloudwatchevent_rule_module.rst @@ -484,7 +484,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - community.aws.cloudwatchevent_rule: name: MyCronTask diff --git a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst index b63996742f1..3635b8f5839 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_info_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_info_module.rst @@ -251,7 +251,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. - community.aws.cloudwatchlogs_log_group_info: diff --git a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst index 7c2bd4c35ee..c0e448046ba 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst @@ -383,7 +383,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: set metric filter on log group /fluentd/testcase community.aws.cloudwatchlogs_log_group_metric_filter: diff --git a/docs/community.aws.cloudwatchlogs_log_group_module.rst b/docs/community.aws.cloudwatchlogs_log_group_module.rst index ec0487c2247..2dbc487ef7c 100644 --- a/docs/community.aws.cloudwatchlogs_log_group_module.rst +++ b/docs/community.aws.cloudwatchlogs_log_group_module.rst @@ -359,7 +359,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.data_pipeline_module.rst b/docs/community.aws.data_pipeline_module.rst index cb76f528188..167cf82e78a 100644 --- a/docs/community.aws.data_pipeline_module.rst +++ b/docs/community.aws.data_pipeline_module.rst @@ -590,7 +590,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.dms_endpoint_module.rst b/docs/community.aws.dms_endpoint_module.rst index b60dcf6ec23..6c1730d99e4 100644 --- a/docs/community.aws.dms_endpoint_module.rst +++ b/docs/community.aws.dms_endpoint_module.rst @@ -646,7 +646,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details - name: Endpoint Creation diff --git a/docs/community.aws.dms_replication_subnet_group_module.rst b/docs/community.aws.dms_replication_subnet_group_module.rst index 3d5ede46d58..25e0fa5b98d 100644 --- a/docs/community.aws.dms_replication_subnet_group_module.rst +++ b/docs/community.aws.dms_replication_subnet_group_module.rst @@ -301,7 +301,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - community.aws.dms_replication_subnet_group: state: present diff --git a/docs/community.aws.dynamodb_table_module.rst b/docs/community.aws.dynamodb_table_module.rst index 2830a0ad5d1..8de198abe68 100644 --- a/docs/community.aws.dynamodb_table_module.rst +++ b/docs/community.aws.dynamodb_table_module.rst @@ -575,7 +575,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create dynamo table with hash and range primary key community.aws.dynamodb_table: diff --git a/docs/community.aws.dynamodb_ttl_module.rst b/docs/community.aws.dynamodb_ttl_module.rst index ad349c13c71..99a2502b13c 100644 --- a/docs/community.aws.dynamodb_ttl_module.rst +++ b/docs/community.aws.dynamodb_ttl_module.rst @@ -288,7 +288,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: enable TTL on my cowfacts table community.aws.dynamodb_ttl: diff --git a/docs/community.aws.ec2_ami_copy_module.rst b/docs/community.aws.ec2_ami_copy_module.rst index 552943b4c2b..42c5f779dff 100644 --- a/docs/community.aws.ec2_ami_copy_module.rst +++ b/docs/community.aws.ec2_ami_copy_module.rst @@ -172,7 +172,7 @@ Parameters @@ -208,7 +208,7 @@ Parameters Default:
"default"
-
The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.)
+
The name of the new AMI to copy. (As of 2.3 the default is default, in prior versions it was null.)
@@ -364,7 +364,7 @@ Parameters -
Wait for the copied AMI to be in state 'available' before returning.
+
Wait for the copied AMI to be in state available before returning.
@@ -380,8 +380,10 @@ Parameters Default:
600
-
How long before wait gives up, in seconds. Prior to 2.3 the default was 1200.
-
From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults. This was reenabled in 2.6 to allow timeouts greater than 10 minutes.
+
How long before wait gives up, in seconds.
+
Prior to 2.3 the default was 1200.
+
From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults.
+
This was reenabled in 2.6 to allow timeouts greater than 10 minutes.
@@ -401,7 +403,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Basic AMI Copy community.aws.ec2_ami_copy: diff --git a/docs/community.aws.ec2_asg_info_module.rst b/docs/community.aws.ec2_asg_info_module.rst index 425666502e3..70a2bbd4686 100644 --- a/docs/community.aws.ec2_asg_info_module.rst +++ b/docs/community.aws.ec2_asg_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst index c00bb25e6bc..e950d3b0b3e 100644 --- a/docs/community.aws.ec2_asg_lifecycle_hook_module.rst +++ b/docs/community.aws.ec2_asg_lifecycle_hook_module.rst @@ -390,7 +390,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create / Update lifecycle hook community.aws.ec2_asg_lifecycle_hook: diff --git a/docs/community.aws.ec2_asg_module.rst b/docs/community.aws.ec2_asg_module.rst index 194fe290b56..29ed893ada5 100644 --- a/docs/community.aws.ec2_asg_module.rst +++ b/docs/community.aws.ec2_asg_module.rst @@ -848,7 +848,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Basic configuration with Launch Configuration diff --git a/docs/community.aws.ec2_customer_gateway_info_module.rst b/docs/community.aws.ec2_customer_gateway_info_module.rst index 4263316fbd5..3d08a50f855 100644 --- a/docs/community.aws.ec2_customer_gateway_info_module.rst +++ b/docs/community.aws.ec2_customer_gateway_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_customer_gateway_module.rst b/docs/community.aws.ec2_customer_gateway_module.rst index c4ff5ff1c53..9d81a8bcb54 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -322,7 +322,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create Customer Gateway community.aws.ec2_customer_gateway: diff --git a/docs/community.aws.ec2_eip_info_module.rst b/docs/community.aws.ec2_eip_info_module.rst index 48ac479ecbc..d742f823cc0 100644 --- a/docs/community.aws.ec2_eip_info_module.rst +++ b/docs/community.aws.ec2_eip_info_module.rst @@ -250,7 +250,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details or the AWS region, # see the AWS Guide for details. diff --git a/docs/community.aws.ec2_eip_module.rst b/docs/community.aws.ec2_eip_module.rst index 366ec5f2da1..efce79cd9fd 100644 --- a/docs/community.aws.ec2_eip_module.rst +++ b/docs/community.aws.ec2_eip_module.rst @@ -442,7 +442,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_elb_info_module.rst b/docs/community.aws.ec2_elb_info_module.rst index f03e94fba5d..7689fb8882f 100644 --- a/docs/community.aws.ec2_elb_info_module.rst +++ b/docs/community.aws.ec2_elb_info_module.rst @@ -250,7 +250,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # Output format tries to match amazon.aws.ec2_elb_lb module input parameters diff --git a/docs/community.aws.ec2_elb_module.rst b/docs/community.aws.ec2_elb_module.rst index f8c22d56048..39b33d7c74b 100644 --- a/docs/community.aws.ec2_elb_module.rst +++ b/docs/community.aws.ec2_elb_module.rst @@ -342,7 +342,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # basic pre_task and post_task example pre_tasks: diff --git a/docs/community.aws.ec2_instance_info_module.rst b/docs/community.aws.ec2_instance_info_module.rst index d55e2c6d153..3e64fafff6b 100644 --- a/docs/community.aws.ec2_instance_info_module.rst +++ b/docs/community.aws.ec2_instance_info_module.rst @@ -268,7 +268,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_instance_module.rst b/docs/community.aws.ec2_instance_module.rst index b65b17689ae..b73c67dac9e 100644 --- a/docs/community.aws.ec2_instance_module.rst +++ b/docs/community.aws.ec2_instance_module.rst @@ -1123,7 +1123,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_launch_template_module.rst b/docs/community.aws.ec2_launch_template_module.rst index 6084bc6f570..12fda30b8a4 100644 --- a/docs/community.aws.ec2_launch_template_module.rst +++ b/docs/community.aws.ec2_launch_template_module.rst @@ -1286,7 +1286,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create an ec2 launch template community.aws.ec2_launch_template: diff --git a/docs/community.aws.ec2_lc_find_module.rst b/docs/community.aws.ec2_lc_find_module.rst index 99a9b61cf2d..803e4898d12 100644 --- a/docs/community.aws.ec2_lc_find_module.rst +++ b/docs/community.aws.ec2_lc_find_module.rst @@ -289,7 +289,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_lc_info_module.rst b/docs/community.aws.ec2_lc_info_module.rst index 3904079fd98..e8b6bcecd0b 100644 --- a/docs/community.aws.ec2_lc_info_module.rst +++ b/docs/community.aws.ec2_lc_info_module.rst @@ -328,7 +328,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_lc_module.rst b/docs/community.aws.ec2_lc_module.rst index 68c6e2348b1..af1f0bff3f3 100644 --- a/docs/community.aws.ec2_lc_module.rst +++ b/docs/community.aws.ec2_lc_module.rst @@ -762,7 +762,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # create a launch configuration using an AMI image and instance type as a basis diff --git a/docs/community.aws.ec2_metric_alarm_module.rst b/docs/community.aws.ec2_metric_alarm_module.rst index 6db3511014c..290374d62f6 100644 --- a/docs/community.aws.ec2_metric_alarm_module.rst +++ b/docs/community.aws.ec2_metric_alarm_module.rst @@ -539,7 +539,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create alarm community.aws.ec2_metric_alarm: diff --git a/docs/community.aws.ec2_placement_group_info_module.rst b/docs/community.aws.ec2_placement_group_info_module.rst index a4304271945..e231cde5eab 100644 --- a/docs/community.aws.ec2_placement_group_info_module.rst +++ b/docs/community.aws.ec2_placement_group_info_module.rst @@ -251,7 +251,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details or the AWS region, # see the AWS Guide for details. diff --git a/docs/community.aws.ec2_placement_group_module.rst b/docs/community.aws.ec2_placement_group_module.rst index d86500ecad8..8c9186c2349 100644 --- a/docs/community.aws.ec2_placement_group_module.rst +++ b/docs/community.aws.ec2_placement_group_module.rst @@ -287,7 +287,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide # for details. diff --git a/docs/community.aws.ec2_scaling_policy_module.rst b/docs/community.aws.ec2_scaling_policy_module.rst index e501135c211..76dab5ffd11 100644 --- a/docs/community.aws.ec2_scaling_policy_module.rst +++ b/docs/community.aws.ec2_scaling_policy_module.rst @@ -481,7 +481,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Simple Scale Down policy community.aws.ec2_scaling_policy: diff --git a/docs/community.aws.ec2_snapshot_copy_module.rst b/docs/community.aws.ec2_snapshot_copy_module.rst index 68b68e4fb3b..f3f55ee91e5 100644 --- a/docs/community.aws.ec2_snapshot_copy_module.rst +++ b/docs/community.aws.ec2_snapshot_copy_module.rst @@ -365,7 +365,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Basic Snapshot Copy community.aws.ec2_snapshot_copy: diff --git a/docs/community.aws.ec2_transit_gateway_info_module.rst b/docs/community.aws.ec2_transit_gateway_info_module.rst index 3a3e807b3f0..052da82c68b 100644 --- a/docs/community.aws.ec2_transit_gateway_info_module.rst +++ b/docs/community.aws.ec2_transit_gateway_info_module.rst @@ -267,7 +267,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_transit_gateway_module.rst b/docs/community.aws.ec2_transit_gateway_module.rst index a318344d39e..669edfae9bb 100644 --- a/docs/community.aws.ec2_transit_gateway_module.rst +++ b/docs/community.aws.ec2_transit_gateway_module.rst @@ -467,7 +467,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a new transit gateway using defaults community.aws.ec2_transit_gateway: diff --git a/docs/community.aws.ec2_vpc_egress_igw_module.rst b/docs/community.aws.ec2_vpc_egress_igw_module.rst index 0bbb3380bf9..6d309eab2b7 100644 --- a/docs/community.aws.ec2_vpc_egress_igw_module.rst +++ b/docs/community.aws.ec2_vpc_egress_igw_module.rst @@ -268,7 +268,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_endpoint_info_module.rst b/docs/community.aws.ec2_vpc_endpoint_info_module.rst index 1baf738914d..3b44f48627b 100644 --- a/docs/community.aws.ec2_vpc_endpoint_info_module.rst +++ b/docs/community.aws.ec2_vpc_endpoint_info_module.rst @@ -286,7 +286,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Simple example of listing all support AWS services for VPC endpoints - name: List supported AWS endpoint services diff --git a/docs/community.aws.ec2_vpc_endpoint_module.rst b/docs/community.aws.ec2_vpc_endpoint_module.rst index 9dc3dd6b3d8..130139ed516 100644 --- a/docs/community.aws.ec2_vpc_endpoint_module.rst +++ b/docs/community.aws.ec2_vpc_endpoint_module.rst @@ -401,7 +401,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_igw_info_module.rst b/docs/community.aws.ec2_vpc_igw_info_module.rst index 26501c07324..0085fb9fc8d 100644 --- a/docs/community.aws.ec2_vpc_igw_info_module.rst +++ b/docs/community.aws.ec2_vpc_igw_info_module.rst @@ -112,6 +112,27 @@ Parameters

aliases: ec2_secret_key, secret_key
+ + +
+ convert_tags + +
+ boolean +
+
added in 1.3.0
+ + + + + +
Convert tags from boto3 format (list of dictionaries) to the standard dictionary format.
+
This currently defaults to False. The default will be changed to True after 2022-06-22.
+ +
@@ -266,7 +287,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_igw_module.rst b/docs/community.aws.ec2_vpc_igw_module.rst index 7666f959200..f61e4d1b0dd 100644 --- a/docs/community.aws.ec2_vpc_igw_module.rst +++ b/docs/community.aws.ec2_vpc_igw_module.rst @@ -165,6 +165,26 @@ Parameters

aliases: aws_profile
+ + +
+ purge_tags + +
+ boolean +
+
added in 1.3.0
+ + + + + +
Remove tags not listed in tags.
+ +
@@ -230,7 +250,8 @@ Parameters -
A dict of tags to apply to the internet gateway. Any tags currently applied to the internet gateway and not present here will be removed.
+
A dict of tags to apply to the internet gateway.
+
To remove all tags set tags={} and purge_tags=true.

aliases: resource_tags
@@ -286,7 +307,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_nacl_info_module.rst b/docs/community.aws.ec2_vpc_nacl_info_module.rst index 2c65f0821ae..2a433f70523 100644 --- a/docs/community.aws.ec2_vpc_nacl_info_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_info_module.rst @@ -270,7 +270,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_nacl_module.rst b/docs/community.aws.ec2_vpc_nacl_module.rst index eea6e32831d..ebfc0f470b2 100644 --- a/docs/community.aws.ec2_vpc_nacl_module.rst +++ b/docs/community.aws.ec2_vpc_nacl_module.rst @@ -371,7 +371,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Complete example to create and delete a network ACL # that allows SSH, HTTP and ICMP in, and all traffic out. diff --git a/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst b/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst index 15179783301..a0f96adcf3c 100644 --- a/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst +++ b/docs/community.aws.ec2_vpc_nat_gateway_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Simple example of listing all nat gateways - name: List all managed nat gateways in ap-southeast-2 diff --git a/docs/community.aws.ec2_vpc_nat_gateway_module.rst b/docs/community.aws.ec2_vpc_nat_gateway_module.rst index 7beb9612ce0..ec295043144 100644 --- a/docs/community.aws.ec2_vpc_nat_gateway_module.rst +++ b/docs/community.aws.ec2_vpc_nat_gateway_module.rst @@ -404,7 +404,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_peer_module.rst b/docs/community.aws.ec2_vpc_peer_module.rst index f518d226230..bd29531d21e 100644 --- a/docs/community.aws.ec2_vpc_peer_module.rst +++ b/docs/community.aws.ec2_vpc_peer_module.rst @@ -347,7 +347,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Complete example to create and accept a local peering connection. - name: Create local account VPC peering Connection diff --git a/docs/community.aws.ec2_vpc_peering_info_module.rst b/docs/community.aws.ec2_vpc_peering_info_module.rst index ffdb565fa5b..ba19ed0b2c9 100644 --- a/docs/community.aws.ec2_vpc_peering_info_module.rst +++ b/docs/community.aws.ec2_vpc_peering_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Simple example of listing all VPC Peers - name: List all vpc peers diff --git a/docs/community.aws.ec2_vpc_route_table_info_module.rst b/docs/community.aws.ec2_vpc_route_table_info_module.rst index 56ae4dd03ea..99b8f0021f3 100644 --- a/docs/community.aws.ec2_vpc_route_table_info_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_info_module.rst @@ -249,7 +249,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_route_table_module.rst b/docs/community.aws.ec2_vpc_route_table_module.rst index f1d179eeac6..b083c49731f 100644 --- a/docs/community.aws.ec2_vpc_route_table_module.rst +++ b/docs/community.aws.ec2_vpc_route_table_module.rst @@ -425,7 +425,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_vgw_info_module.rst b/docs/community.aws.ec2_vpc_vgw_info_module.rst index 1d0fef4366b..a61eb76c01b 100644 --- a/docs/community.aws.ec2_vpc_vgw_info_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ec2_vpc_vgw_module.rst b/docs/community.aws.ec2_vpc_vgw_module.rst index 8e6fe8c5908..b6654ad119f 100644 --- a/docs/community.aws.ec2_vpc_vgw_module.rst +++ b/docs/community.aws.ec2_vpc_vgw_module.rst @@ -367,7 +367,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a new vgw attached to a specific VPC community.aws.ec2_vpc_vgw: diff --git a/docs/community.aws.ec2_vpc_vpn_info_module.rst b/docs/community.aws.ec2_vpc_vpn_info_module.rst index e8eda1b5c95..b182e0279ba 100644 --- a/docs/community.aws.ec2_vpc_vpn_info_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_info_module.rst @@ -266,7 +266,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # # Note: These examples do not set authentication details, see the AWS Guide for details. - name: Gather information about all vpn connections diff --git a/docs/community.aws.ec2_vpc_vpn_module.rst b/docs/community.aws.ec2_vpc_vpn_module.rst index 72426420bc2..b6fca122c45 100644 --- a/docs/community.aws.ec2_vpc_vpn_module.rst +++ b/docs/community.aws.ec2_vpc_vpn_module.rst @@ -126,7 +126,7 @@ Parameters
The type of VPN connection.
-
At this time only 'ipsec.1' is supported.
+
At this time only ipsec.1 is supported.
@@ -176,7 +176,7 @@ Parameters Default:
15
-
The time to wait before checking operation again. in seconds.
+
The time, in seconds, to wait before checking operation again.
@@ -207,7 +207,7 @@ Parameters -
An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id is required. If one of the following suboptions is a list of items to filter by, only one item needs to match to find the VPN that correlates. e.g. if the filter 'cidr' is ['194.168.2.0/24', '192.168.2.0/24'] and the VPN route only has the destination cidr block of '192.168.2.0/24' it will be found with this filter (assuming there are not multiple VPNs that are matched). Another example, if the filter 'vpn' is equal to ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] and one of of the VPNs has the state deleted (exists but is unmodifiable) and the other exists and is not deleted, it will be found via this filter. See examples.
+
An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id is required. If one of the following suboptions is a list of items to filter by, only one item needs to match to find the VPN that correlates. e.g. if the filter cidr is ['194.168.2.0/24', '192.168.2.0/24'] and the VPN route only has the destination cidr block of 192.168.2.0/24 it will be found with this filter (assuming there are not multiple VPNs that are matched). Another example, if the filter vpn is equal to ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] and one of of the VPNs has the state deleted (exists but is unmodifiable) and the other exists and is not deleted, it will be found via this filter. See examples.
@@ -287,7 +287,7 @@ Parameters -
The type of routing; true or false.
+
The type of routing; true or false.
@@ -400,7 +400,7 @@ Parameters @@ -543,7 +543,7 @@ Parameters -
An optional list object containing no more than two dict members, each of which may contain 'TunnelInsideCidr' and/or 'PreSharedKey' keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.
+
An optional list object containing no more than two dict members, each of which may contain TunnelInsideCidr and/or PreSharedKey keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.
@@ -641,7 +641,7 @@ Parameters Default:
600
-
How long before wait gives up, in seconds.
+
How long, in seconds, before wait gives up.
@@ -661,7 +661,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.ec2_win_password_module.rst b/docs/community.aws.ec2_win_password_module.rst index dc384260d46..4e3aca0c7af 100644 --- a/docs/community.aws.ec2_win_password_module.rst +++ b/docs/community.aws.ec2_win_password_module.rst @@ -334,7 +334,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Example of getting a password - name: get the Administrator password diff --git a/docs/community.aws.ecs_attribute_module.rst b/docs/community.aws.ecs_attribute_module.rst index 1bb479db5ac..6c9dc4f6e64 100644 --- a/docs/community.aws.ecs_attribute_module.rst +++ b/docs/community.aws.ecs_attribute_module.rst @@ -337,7 +337,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ecs_cluster_module.rst b/docs/community.aws.ecs_cluster_module.rst index 43831341e6a..c198e3fcba4 100644 --- a/docs/community.aws.ecs_cluster_module.rst +++ b/docs/community.aws.ecs_cluster_module.rst @@ -305,7 +305,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ecs_ecr_module.rst b/docs/community.aws.ecs_ecr_module.rst index 0c17a0863e7..853e153ab9d 100644 --- a/docs/community.aws.ecs_ecr_module.rst +++ b/docs/community.aws.ecs_ecr_module.rst @@ -196,7 +196,7 @@ Parameters -
JSON or dict that represents the new lifecycle policy
+
JSON or dict that represents the new lifecycle policy.
@@ -259,12 +259,13 @@ Parameters -
if yes, remove the lifecycle policy from the repository
+
if true, remove the lifecycle policy from the repository.
+
Defaults to false.
@@ -278,13 +279,14 @@ Parameters
If yes, remove the policy from the repository.
Alias delete_policy has been deprecated and will be removed after 2022-06-01.
+
Defaults to false.

aliases: delete_policy
@@ -320,6 +322,27 @@ Parameters
If not specified, the default registry is assumed.
+ + +
+ scan_on_push + +
+ boolean +
+
added in 1.3.0
+ + + + + +
if true, images are scanned for known vulnerabilities after being pushed to the repository.
+
scan_on_push requires botocore >= 1.13.3
+ +
@@ -393,7 +416,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # If the repository does not exist, it is created. If it does exist, would not # affect any policies already on it. @@ -444,6 +467,7 @@ Examples - name: set-lifecycle-policy community.aws.ecs_ecr: name: needs-lifecycle-policy + scan_on_push: yes lifecycle_policy: rules: - rulePriority: 1 diff --git a/docs/community.aws.ecs_service_info_module.rst b/docs/community.aws.ecs_service_info_module.rst index 11414624b85..4d60e6d3480 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -306,7 +306,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ecs_service_module.rst b/docs/community.aws.ecs_service_module.rst index 39b9fc3f3dd..a16229f3379 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -270,7 +270,7 @@ Parameters @@ -320,7 +320,7 @@ Parameters
list - / elements=string + / elements=dictionary
@@ -396,7 +396,7 @@ Parameters -
A list of security group names or group IDs to associate with the task
+
A list of security group names or group IDs to associate with the task.
@@ -413,7 +413,7 @@ Parameters -
A list of subnet IDs to associate with the task
+
A list of subnet IDs to associate with the task.
@@ -598,7 +598,8 @@ Parameters -
The scheduling strategy, defaults to "REPLICA" if not given to preserve previous behavior
+
The scheduling strategy.
+
Defaults to REPLICA if not given to preserve previous behavior.
@@ -648,7 +649,7 @@ Parameters -
Service discovery registry ARN
+
Service discovery registry ARN.
@@ -664,7 +665,7 @@ Parameters -
container name for service discovery registration
+
Container name for service discovery registration.
@@ -680,7 +681,7 @@ Parameters -
container port for service discovery registration
+
Container port for service discovery registration.
@@ -760,7 +761,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ecs_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index 268a9b8b018..bbd6c2f793f 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -346,7 +346,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Ensure tags are present on a resource community.aws.ecs_tag: diff --git a/docs/community.aws.ecs_task_module.rst b/docs/community.aws.ecs_task_module.rst index 77ffea44c44..ce9bbb96799 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -447,7 +447,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Simple example of run task - name: Run task diff --git a/docs/community.aws.ecs_taskdefinition_info_module.rst b/docs/community.aws.ecs_taskdefinition_info_module.rst index d444d4579df..01f268e4ac5 100644 --- a/docs/community.aws.ecs_taskdefinition_info_module.rst +++ b/docs/community.aws.ecs_taskdefinition_info_module.rst @@ -254,7 +254,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.ecs_taskdefinition_module.rst b/docs/community.aws.ecs_taskdefinition_module.rst index 9dec6ee0f82..2df741f9e84 100644 --- a/docs/community.aws.ecs_taskdefinition_module.rst +++ b/docs/community.aws.ecs_taskdefinition_module.rst @@ -135,7 +135,7 @@ Parameters
list - / elements=string + / elements=dictionary
@@ -236,7 +236,7 @@ Parameters @@ -276,7 +276,7 @@ Parameters
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.
-
If using the Fargate launch type, this field is required and is limited by the cpu.
+
If using the Fargate launch type, this field is required and is limited by the CPU.
@@ -476,7 +476,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create task definition community.aws.ecs_taskdefinition: diff --git a/docs/community.aws.efs_info_module.rst b/docs/community.aws.efs_info_module.rst index c7c354e76ab..ab8ebd81da8 100644 --- a/docs/community.aws.efs_info_module.rst +++ b/docs/community.aws.efs_info_module.rst @@ -298,7 +298,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Find all existing efs community.aws.efs_info: diff --git a/docs/community.aws.efs_module.rst b/docs/community.aws.efs_module.rst index 52bdeef7989..06279ae5a2b 100644 --- a/docs/community.aws.efs_module.rst +++ b/docs/community.aws.efs_module.rst @@ -508,7 +508,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: EFS provisioning community.aws.efs: diff --git a/docs/community.aws.elasticache_info_module.rst b/docs/community.aws.elasticache_info_module.rst index 34c698e53f5..34254514c00 100644 --- a/docs/community.aws.elasticache_info_module.rst +++ b/docs/community.aws.elasticache_info_module.rst @@ -249,7 +249,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: obtain all ElastiCache information community.aws.elasticache_info: diff --git a/docs/community.aws.elasticache_module.rst b/docs/community.aws.elasticache_module.rst index 88963c4a5b1..533176eec1f 100644 --- a/docs/community.aws.elasticache_module.rst +++ b/docs/community.aws.elasticache_module.rst @@ -171,7 +171,7 @@ Parameters -
A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc.
+
A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a VPC.
@@ -186,8 +186,8 @@ Parameters -
The subnet group name to associate with. Only use if inside a vpc.
-
Required if inside a vpc
+
The subnet group name to associate with. Only use if inside a VPC.
+
Required if inside a VPC.
@@ -253,12 +253,13 @@ Parameters
Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state.
+
Defaults to false.
@@ -357,7 +358,7 @@ Parameters -
A list of vpc security group IDs to associate with this cache cluster. Only use if inside a vpc.
+
A list of VPC security group IDs to associate with this cache cluster. Only use if inside a VPC.
@@ -470,7 +471,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.elasticache_parameter_group_module.rst b/docs/community.aws.elasticache_parameter_group_module.rst index f458bbda6b8..d7554eb5d56 100644 --- a/docs/community.aws.elasticache_parameter_group_module.rst +++ b/docs/community.aws.elasticache_parameter_group_module.rst @@ -327,7 +327,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.elasticache_snapshot_module.rst b/docs/community.aws.elasticache_snapshot_module.rst index 3ac68c664bd..73ccdec22d3 100644 --- a/docs/community.aws.elasticache_snapshot_module.rst +++ b/docs/community.aws.elasticache_snapshot_module.rst @@ -333,7 +333,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.elasticache_subnet_group_module.rst b/docs/community.aws.elasticache_subnet_group_module.rst index f566eb8d07f..cedd9859da5 100644 --- a/docs/community.aws.elasticache_subnet_group_module.rst +++ b/docs/community.aws.elasticache_subnet_group_module.rst @@ -300,7 +300,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Add or change a subnet group community.aws.elasticache_subnet_group: diff --git a/docs/community.aws.elb_application_lb_info_module.rst b/docs/community.aws.elb_application_lb_info_module.rst index fb0e67cc590..ef71064e90b 100644 --- a/docs/community.aws.elb_application_lb_info_module.rst +++ b/docs/community.aws.elb_application_lb_info_module.rst @@ -267,7 +267,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.elb_application_lb_module.rst b/docs/community.aws.elb_application_lb_module.rst index 7ea443c49a2..cae74399a5d 100644 --- a/docs/community.aws.elb_application_lb_module.rst +++ b/docs/community.aws.elb_application_lb_module.rst @@ -5,7 +5,7 @@ community.aws.elb_application_lb ******************************** -**Manage an Application load balancer** +**Manage an Application Load Balancer** Version added: 1.0.0 @@ -196,12 +196,13 @@ Parameters
Indicates whether deletion protection for the ELB is enabled.
+
Defaults to false.
@@ -231,12 +232,13 @@ Parameters
Indicates whether to enable HTTP2 routing.
+
Defaults to false.
@@ -530,7 +532,8 @@ Parameters -
If yes, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter. If the listeners parameter is not set then listeners will not be modified
+
If yes, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter.
+
If the listeners parameter is not set then listeners will not be modified.
@@ -549,7 +552,7 @@ Parameters -
When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.
+
When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.
@@ -568,7 +571,8 @@ Parameters -
If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
+
If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
+
If the tags parameter is not set then tags will not be modified.
@@ -765,7 +769,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.elb_classic_lb_info_module.rst b/docs/community.aws.elb_classic_lb_info_module.rst index 8a2658fb30c..a6a90f89ee5 100644 --- a/docs/community.aws.elb_classic_lb_info_module.rst +++ b/docs/community.aws.elb_classic_lb_info_module.rst @@ -252,7 +252,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # Output format tries to match amazon.aws.ec2_elb_lb module input parameters diff --git a/docs/community.aws.elb_classic_lb_module.rst b/docs/community.aws.elb_classic_lb_module.rst index 177e119e7e6..85612a0453c 100644 --- a/docs/community.aws.elb_classic_lb_module.rst +++ b/docs/community.aws.elb_classic_lb_module.rst @@ -53,7 +53,7 @@ Parameters -
An associative array of access logs configuration settings (see example)
+
An associative array of access logs configuration settings (see example).
@@ -138,7 +138,7 @@ Parameters -
Wait a specified timeout allowing connections to drain before terminating an instance
+
Wait a specified timeout allowing connections to drain before terminating an instance.
@@ -152,12 +152,13 @@ Parameters -
Distribute load across all configured Availability Zones
+
Distribute load across all configured Availability Zones.
+
Defaults to false.
@@ -207,7 +208,7 @@ Parameters -
An associative array of health check configuration settings (see example)
+
An associative array of health check configuration settings (see example).
@@ -222,7 +223,7 @@ Parameters -
ELB connections from clients and to servers are timed out after this amount of time
+
ELB connections from clients and to servers are timed out after this amount of time.
@@ -238,7 +239,7 @@ Parameters -
List of instance ids to attach to this ELB
+
List of instance ids to attach to this ELB.
@@ -254,7 +255,7 @@ Parameters -
List of ports/protocols for this ELB to listen on (see example)
+
List of ports/protocols for this ELB to listen on (see example).
@@ -270,7 +271,7 @@ Parameters -
The name of the ELB
+
The name of the ELB.
@@ -307,7 +308,7 @@ Parameters -
Purge existing instance ids on ELB that are not found in instance_ids
+
Purge existing instance ids on ELB that are not found in instance_ids.
@@ -326,7 +327,7 @@ Parameters -
Purge existing listeners on ELB that are not found in listeners
+
Purge existing listeners on ELB that are not found in listeners.
@@ -345,7 +346,7 @@ Parameters -
Purge existing subnet on ELB that are not found in subnets
+
Purge existing subnets on ELB that are not found in subnets.
@@ -364,7 +365,7 @@ Parameters -
Purge existing availability zones on ELB that are not found in zones
+
Purge existing availability zones on ELB that are not found in zones.
@@ -399,7 +400,9 @@ Parameters -
The scheme to use when creating the ELB. For a private VPC-visible ELB use 'internal'. If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must use the option wait.
+
The scheme to use when creating the ELB.
+
For a private VPC-visible ELB use internal.
+
If you choose to update your scheme with a different value the ELB will be destroyed and recreated. To update scheme you must set wait=true.
@@ -415,7 +418,7 @@ Parameters -
A list of security groups to apply to the elb
+
A list of security groups to apply to the ELB.
@@ -431,7 +434,7 @@ Parameters -
A list of security group names to apply to the elb
+
A list of security group names to apply to the ELB.
@@ -469,7 +472,7 @@ Parameters -
Create or destroy the ELB
+
Create or destroy the ELB.
@@ -484,7 +487,7 @@ Parameters -
An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example )
+
An associative array of stickiness policy settings. Policy will be applied to all listeners (see example).
@@ -534,7 +537,7 @@ Parameters -
When set to no, SSL certificates will not be validated for boto versions >= 2.6.0.
+
When set to false, SSL certificates will not be validated for boto versions >= 2.6.0.
@@ -569,7 +572,7 @@ Parameters Default:
60
-
Used in conjunction with wait. Number of seconds to wait for the elb to be terminated. A maximum of 600 seconds (10 minutes) is allowed.
+
Used in conjunction with wait. Number of seconds to wait for the ELB to be terminated. A maximum of 600 seconds (10 minutes) is allowed.
@@ -585,7 +588,7 @@ Parameters -
List of availability zones to enable on this ELB
+
List of availability zones to enable on this ELB.
@@ -605,7 +608,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: None of these examples set aws_access_key, aws_secret_key, or region. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.elb_instance_module.rst b/docs/community.aws.elb_instance_module.rst index 5f642a591d7..be68b327065 100644 --- a/docs/community.aws.elb_instance_module.rst +++ b/docs/community.aws.elb_instance_module.rst @@ -341,7 +341,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # basic pre_task and post_task example pre_tasks: diff --git a/docs/community.aws.elb_network_lb_module.rst b/docs/community.aws.elb_network_lb_module.rst index ed7f91a05bf..79895efaac0 100644 --- a/docs/community.aws.elb_network_lb_module.rst +++ b/docs/community.aws.elb_network_lb_module.rst @@ -122,12 +122,13 @@ Parameters
Indicates whether cross-zone load balancing is enabled.
+
Defaults to false.
@@ -160,12 +161,13 @@ Parameters
Indicates whether deletion protection for the ELB is enabled.
+
Defaults to false.
@@ -608,7 +610,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.elb_target_group_info_module.rst b/docs/community.aws.elb_target_group_info_module.rst index 83511da09a7..4ee35257c3c 100644 --- a/docs/community.aws.elb_target_group_info_module.rst +++ b/docs/community.aws.elb_target_group_info_module.rst @@ -301,7 +301,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.elb_target_group_module.rst b/docs/community.aws.elb_target_group_module.rst index 5b39b157349..231df473c1d 100644 --- a/docs/community.aws.elb_target_group_module.rst +++ b/docs/community.aws.elb_target_group_module.rst @@ -658,7 +658,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.elb_target_info_module.rst b/docs/community.aws.elb_target_info_module.rst index 918be270c54..53d29e3295c 100644 --- a/docs/community.aws.elb_target_info_module.rst +++ b/docs/community.aws.elb_target_info_module.rst @@ -271,7 +271,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # practical use case - dynamically de-registering and re-registering nodes diff --git a/docs/community.aws.elb_target_module.rst b/docs/community.aws.elb_target_module.rst index d208c11de88..f596429753d 100644 --- a/docs/community.aws.elb_target_module.rst +++ b/docs/community.aws.elb_target_module.rst @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Used to register or deregister a target in a target group +- Used to register or deregister a target in a target group. @@ -140,12 +140,13 @@ Parameters -
The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them set deregister_unused to yes.
+
The default behaviour for targets that are unused is to leave them registered.
+
If instead you would like to remove them set deregister_unused=true.
@@ -248,7 +249,7 @@ Parameters -
An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance.
+
An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance.
@@ -263,7 +264,8 @@ Parameters -
The Amazon Resource Name (ARN) of the target group. Mutually exclusive of target_group_name.
+
The Amazon Resource Name (ARN) of the target group.
+
Mutually exclusive of target_group_name.
@@ -278,7 +280,8 @@ Parameters -
The name of the target group. Mutually exclusive of target_group_arn.
+
The name of the target group.
+
Mutually exclusive of target_group_arn.
@@ -349,7 +352,7 @@ Parameters Default:
60
-
Maximum time in seconds to wait for target_status change
+
Maximum time in seconds to wait for target_status change.
@@ -389,7 +392,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.execute_lambda_module.rst b/docs/community.aws.execute_lambda_module.rst index 917a3c56e5a..4e9b5d6f4a2 100644 --- a/docs/community.aws.execute_lambda_module.rst +++ b/docs/community.aws.execute_lambda_module.rst @@ -354,7 +354,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - community.aws.execute_lambda: name: test-function diff --git a/docs/community.aws.iam_cert_module.rst b/docs/community.aws.iam_cert_module.rst index f76ee1ed3dc..52d02622b65 100644 --- a/docs/community.aws.iam_cert_module.rst +++ b/docs/community.aws.iam_cert_module.rst @@ -170,13 +170,14 @@ 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.
@@ -238,8 +239,8 @@ Parameters -
When state is present, this will update the name of the cert.
-
The cert, key and cert_chain parameters will be ignored if this is defined.
+
When state=present, this will update the name of the cert.
+
The cert, key and cert_chain parameters will be ignored if this is defined.
@@ -254,7 +255,7 @@ Parameters -
When state is present, this will update the path of the cert.
+
When state=present, this will update the path of the cert.
The cert, key and cert_chain parameters will be ignored if this is defined.
@@ -343,7 +344,7 @@ Parameters -
Whether to create(or update) or delete the certificate.
+
Whether to create (or update) or delete the certificate.
If new_path or new_name is defined, specifying present will attempt to make an update these.
@@ -383,7 +384,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Basic server certificate upload from local file community.aws.iam_cert: diff --git a/docs/community.aws.iam_group_module.rst b/docs/community.aws.iam_group_module.rst index 9ee2a4e6f82..2eb85c16334 100644 --- a/docs/community.aws.iam_group_module.rst +++ b/docs/community.aws.iam_group_module.rst @@ -344,7 +344,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.iam_managed_policy_module.rst b/docs/community.aws.iam_managed_policy_module.rst index 05567a58001..56ed8f76cd9 100644 --- a/docs/community.aws.iam_managed_policy_module.rst +++ b/docs/community.aws.iam_managed_policy_module.rst @@ -358,7 +358,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create Policy ex nihilo - name: Create IAM Managed Policy diff --git a/docs/community.aws.iam_mfa_device_info_module.rst b/docs/community.aws.iam_mfa_device_info_module.rst index 96e267dd8ee..b76f802ef87 100644 --- a/docs/community.aws.iam_mfa_device_info_module.rst +++ b/docs/community.aws.iam_mfa_device_info_module.rst @@ -251,7 +251,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.iam_module.rst b/docs/community.aws.iam_module.rst index 936ee464e94..be1e539d5d2 100644 --- a/docs/community.aws.iam_module.rst +++ b/docs/community.aws.iam_module.rst @@ -481,7 +481,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Basic user creation example - name: Create two new IAM users with API keys diff --git a/docs/community.aws.iam_password_policy_module.rst b/docs/community.aws.iam_password_policy_module.rst index 7d4133619ed..e1bdb8ce9fe 100644 --- a/docs/community.aws.iam_password_policy_module.rst +++ b/docs/community.aws.iam_password_policy_module.rst @@ -422,7 +422,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Password policy for AWS account community.aws.iam_password_policy: diff --git a/docs/community.aws.iam_policy_info_module.rst b/docs/community.aws.iam_policy_info_module.rst index 3fffa1c62b7..6d06db1d93f 100644 --- a/docs/community.aws.iam_policy_info_module.rst +++ b/docs/community.aws.iam_policy_info_module.rst @@ -285,7 +285,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Describe all inline IAM policies on an IAM User community.aws.iam_policy_info: diff --git a/docs/community.aws.iam_policy_module.rst b/docs/community.aws.iam_policy_module.rst index bdbb15cc7c2..f976ac1a4d0 100644 --- a/docs/community.aws.iam_policy_module.rst +++ b/docs/community.aws.iam_policy_module.rst @@ -360,7 +360,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create a policy with the name of 'Admin' to the group 'administrators' - name: Assign a policy called Admin to the administrators group diff --git a/docs/community.aws.iam_role_info_module.rst b/docs/community.aws.iam_role_info_module.rst index 1c6c56914cb..2e3abc9fe1e 100644 --- a/docs/community.aws.iam_role_info_module.rst +++ b/docs/community.aws.iam_role_info_module.rst @@ -268,7 +268,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: find all existing IAM roles community.aws.iam_role_info: diff --git a/docs/community.aws.iam_role_module.rst b/docs/community.aws.iam_role_module.rst index efdb1928a51..e81541d815a 100644 --- a/docs/community.aws.iam_role_module.rst +++ b/docs/community.aws.iam_role_module.rst @@ -467,7 +467,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.iam_saml_federation_module.rst b/docs/community.aws.iam_saml_federation_module.rst index c741777dd30..3e9ac69b646 100644 --- a/docs/community.aws.iam_saml_federation_module.rst +++ b/docs/community.aws.iam_saml_federation_module.rst @@ -284,7 +284,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # It is assumed that their matching environment variables are set. diff --git a/docs/community.aws.iam_server_certificate_info_module.rst b/docs/community.aws.iam_server_certificate_info_module.rst index a4201eccfc9..c41d2407cb4 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -251,7 +251,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Retrieve server certificate community.aws.iam_server_certificate_info: diff --git a/docs/community.aws.iam_user_info_module.rst b/docs/community.aws.iam_user_info_module.rst index f1d460c3ef6..f33064c0dd6 100644 --- a/docs/community.aws.iam_user_info_module.rst +++ b/docs/community.aws.iam_user_info_module.rst @@ -282,7 +282,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about "test" user. diff --git a/docs/community.aws.iam_user_module.rst b/docs/community.aws.iam_user_module.rst index d3065e79540..de70f8358d3 100644 --- a/docs/community.aws.iam_user_module.rst +++ b/docs/community.aws.iam_user_module.rst @@ -309,7 +309,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. # Note: This module does not allow management of groups that users belong to. diff --git a/docs/community.aws.kinesis_stream_module.rst b/docs/community.aws.kinesis_stream_module.rst index 721b75ed6eb..27b71b0b487 100644 --- a/docs/community.aws.kinesis_stream_module.rst +++ b/docs/community.aws.kinesis_stream_module.rst @@ -411,7 +411,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. @@ -461,6 +461,7 @@ Examples community.aws.kinesis_stream: name: test-stream state: present + shards: 1 encryption_state: enabled encryption_type: KMS key_id: alias/aws/kinesis @@ -473,6 +474,7 @@ Examples community.aws.kinesis_stream: name: test-stream state: present + shards: 1 encryption_state: disabled encryption_type: KMS key_id: alias/aws/kinesis diff --git a/docs/community.aws.lambda_alias_module.rst b/docs/community.aws.lambda_alias_module.rst index 5ff81ec22f0..9687be4015a 100644 --- a/docs/community.aws.lambda_alias_module.rst +++ b/docs/community.aws.lambda_alias_module.rst @@ -317,7 +317,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- # Simple example to create a lambda function and publish a version diff --git a/docs/community.aws.lambda_event_module.rst b/docs/community.aws.lambda_event_module.rst index 15ae5096543..9d10ac318e9 100644 --- a/docs/community.aws.lambda_event_module.rst +++ b/docs/community.aws.lambda_event_module.rst @@ -416,7 +416,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Example that creates a lambda event notification for a DynamoDB stream - name: DynamoDB stream event mapping diff --git a/docs/community.aws.lambda_facts_module.rst b/docs/community.aws.lambda_facts_module.rst index e3176d53608..369bd9399be 100644 --- a/docs/community.aws.lambda_facts_module.rst +++ b/docs/community.aws.lambda_facts_module.rst @@ -295,7 +295,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- # Simple example of listing all info for a function diff --git a/docs/community.aws.lambda_info_module.rst b/docs/community.aws.lambda_info_module.rst index e7ae0f1acf7..ce265e7087d 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -289,7 +289,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- # Simple example of listing all info for a function diff --git a/docs/community.aws.lambda_module.rst b/docs/community.aws.lambda_module.rst index c3d07a7be52..7368c05fed4 100644 --- a/docs/community.aws.lambda_module.rst +++ b/docs/community.aws.lambda_module.rst @@ -529,7 +529,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Create Lambda functions - name: looped creation diff --git a/docs/community.aws.lambda_policy_module.rst b/docs/community.aws.lambda_policy_module.rst index 9f07149200a..6b9fdbf943b 100644 --- a/docs/community.aws.lambda_policy_module.rst +++ b/docs/community.aws.lambda_policy_module.rst @@ -400,7 +400,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Lambda S3 event notification community.aws.lambda_policy: diff --git a/docs/community.aws.lightsail_module.rst b/docs/community.aws.lightsail_module.rst index fdf328bba65..5ff6b603b43 100644 --- a/docs/community.aws.lightsail_module.rst +++ b/docs/community.aws.lightsail_module.rst @@ -391,7 +391,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a new Lightsail instance community.aws.lightsail: diff --git a/docs/community.aws.rds_instance_info_module.rst b/docs/community.aws.rds_instance_info_module.rst index 6071634a1f3..3e199320cb1 100644 --- a/docs/community.aws.rds_instance_info_module.rst +++ b/docs/community.aws.rds_instance_info_module.rst @@ -267,7 +267,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Get information about an instance community.aws.rds_instance_info: diff --git a/docs/community.aws.rds_instance_module.rst b/docs/community.aws.rds_instance_module.rst index 48984b9de6f..aa2210fcf77 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -1437,7 +1437,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. - name: create minimal aurora instance in default VPC and default subnet group diff --git a/docs/community.aws.rds_module.rst b/docs/community.aws.rds_module.rst index 46ed148e695..c3391656668 100644 --- a/docs/community.aws.rds_module.rst +++ b/docs/community.aws.rds_module.rst @@ -844,7 +844,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Basic mysql provisioning example community.aws.rds: diff --git a/docs/community.aws.rds_param_group_module.rst b/docs/community.aws.rds_param_group_module.rst index 89f14e0d3e0..9905c5a88d8 100644 --- a/docs/community.aws.rds_param_group_module.rst +++ b/docs/community.aws.rds_param_group_module.rst @@ -373,7 +373,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Add or change a parameter group, in this case setting auto_increment_increment to 42 * 1024 community.aws.rds_param_group: diff --git a/docs/community.aws.rds_snapshot_info_module.rst b/docs/community.aws.rds_snapshot_info_module.rst index 87b76fccabf..8835ebf4347 100644 --- a/docs/community.aws.rds_snapshot_info_module.rst +++ b/docs/community.aws.rds_snapshot_info_module.rst @@ -323,7 +323,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Get information about an snapshot community.aws.rds_snapshot_info: diff --git a/docs/community.aws.rds_snapshot_module.rst b/docs/community.aws.rds_snapshot_module.rst index 903e7bd5f39..95ec276a159 100644 --- a/docs/community.aws.rds_snapshot_module.rst +++ b/docs/community.aws.rds_snapshot_module.rst @@ -355,7 +355,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create snapshot community.aws.rds_snapshot: diff --git a/docs/community.aws.rds_subnet_group_module.rst b/docs/community.aws.rds_subnet_group_module.rst index 6b681740a27..3b624ccdb09 100644 --- a/docs/community.aws.rds_subnet_group_module.rst +++ b/docs/community.aws.rds_subnet_group_module.rst @@ -302,7 +302,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Add or change a subnet group community.aws.rds_subnet_group: diff --git a/docs/community.aws.redshift_cross_region_snapshots_module.rst b/docs/community.aws.redshift_cross_region_snapshots_module.rst index 2a3c96ac85e..f1ad74a43b6 100644 --- a/docs/community.aws.redshift_cross_region_snapshots_module.rst +++ b/docs/community.aws.redshift_cross_region_snapshots_module.rst @@ -324,7 +324,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure cross-region snapshot on cluster `johniscool` community.aws.redshift_cross_region_snapshots: diff --git a/docs/community.aws.redshift_info_module.rst b/docs/community.aws.redshift_info_module.rst index 8de44f0b838..4d8230f0ea6 100644 --- a/docs/community.aws.redshift_info_module.rst +++ b/docs/community.aws.redshift_info_module.rst @@ -267,7 +267,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do net set authentication details, see the AWS guide for details. diff --git a/docs/community.aws.redshift_module.rst b/docs/community.aws.redshift_module.rst index f1397c0a027..27742aa8b82 100644 --- a/docs/community.aws.redshift_module.rst +++ b/docs/community.aws.redshift_module.rst @@ -556,6 +556,26 @@ Parameters
If the cluster is accessible publicly or not.
+ + +
+ purge_tags + +
+ boolean +
+
added in 1.3.0
+ + + + + +
Purge existing tags that are not found in the cluster
+ +
@@ -611,6 +631,23 @@ Parameters

aliases: skip_final_snapshot
+ + +
+ tags + +
+ dictionary +
+
added in 1.3.0
+ + + + +
A dictionary of resource tags.
+

aliases: resource_tags
+ +
@@ -716,7 +753,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Basic cluster provisioning example community.aws.redshift: @@ -940,6 +977,22 @@ Common return values are documented `here available + +   + +
+ tags + +
+ dictionary +
+ + success + +
aws tags for cluster.
+
+ +   diff --git a/docs/community.aws.redshift_subnet_group_module.rst b/docs/community.aws.redshift_subnet_group_module.rst index c1097805de4..7f66c0334a7 100644 --- a/docs/community.aws.redshift_subnet_group_module.rst +++ b/docs/community.aws.redshift_subnet_group_module.rst @@ -303,7 +303,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a Redshift subnet group community.aws.redshift_subnet_group: diff --git a/docs/community.aws.route53_health_check_module.rst b/docs/community.aws.route53_health_check_module.rst index 7672b0d77b7..b4b25fada6b 100644 --- a/docs/community.aws.route53_health_check_module.rst +++ b/docs/community.aws.route53_health_check_module.rst @@ -400,7 +400,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a health-check for host1.example.com and use it in record community.aws.route53_health_check: diff --git a/docs/community.aws.route53_info_module.rst b/docs/community.aws.route53_info_module.rst index e6b62e7617a..e44d3e25ed0 100644 --- a/docs/community.aws.route53_info_module.rst +++ b/docs/community.aws.route53_info_module.rst @@ -474,7 +474,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Simple example of listing all hosted zones - name: List all hosted zones diff --git a/docs/community.aws.route53_module.rst b/docs/community.aws.route53_module.rst index 1618d2a5c94..1be729b3895 100644 --- a/docs/community.aws.route53_module.rst +++ b/docs/community.aws.route53_module.rst @@ -5,7 +5,7 @@ community.aws.route53 ********************* -**add or delete entries in Amazons Route53 DNS service** +**add or delete entries in Amazons Route 53 DNS service** Version added: 1.0.0 @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Creates and deletes DNS records in Amazons Route53 service +- Creates and deletes DNS records in Amazons Route 53 service. @@ -51,12 +51,13 @@ Parameters
Indicates if this is an alias record.
+
Defaults to false.
@@ -298,7 +299,8 @@ Parameters -
If set to yes, the private zone matching the requested name within the domain will be used if there are both public and private zones. The default is to use the public zone.
+
If set to true, the private zone matching the requested name within the domain will be used if there are both public and private zones.
+
The default is to use the public zone.
@@ -363,7 +365,7 @@ Parameters Default:
500
-
In the case that route53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long.
+
In the case that Route 53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long.
@@ -404,7 +406,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. 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.

aliases: command
@@ -486,7 +488,7 @@ Parameters
The new value when creating a DNS record. YAML lists or multiple comma-spaced values are allowed for non-alias records.
-
When deleting a record all values for the record must be specified or Route53 will not delete it.
+
When deleting a record all values for the record must be specified or Route 53 will not delete it.
@@ -588,7 +590,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Add new.foo.com as an A record with 3 IPs and wait until the changes have been replicated community.aws.route53: diff --git a/docs/community.aws.route53_zone_module.rst b/docs/community.aws.route53_zone_module.rst index b2d46d9e36b..0af97d45d8f 100644 --- a/docs/community.aws.route53_zone_module.rst +++ b/docs/community.aws.route53_zone_module.rst @@ -347,7 +347,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create a public zone community.aws.route53_zone: diff --git a/docs/community.aws.s3_bucket_notification_module.rst b/docs/community.aws.s3_bucket_notification_module.rst index c7729792c5f..a801b0ded68 100644 --- a/docs/community.aws.s3_bucket_notification_module.rst +++ b/docs/community.aws.s3_bucket_notification_module.rst @@ -394,7 +394,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml --- # Example that creates a lambda event notification for a bucket diff --git a/docs/community.aws.s3_lifecycle_module.rst b/docs/community.aws.s3_lifecycle_module.rst index 4cad7c314af..9790bd8f547 100644 --- a/docs/community.aws.s3_lifecycle_module.rst +++ b/docs/community.aws.s3_lifecycle_module.rst @@ -221,6 +221,8 @@ Parameters
  • glacier ←
  • onezone_ia
  • standard_ia
    • +
  • intelligent_tiering
    • +
  • deep_archive
    • @@ -432,10 +434,12 @@ Parameters
  • glacier ←
  • onezone_ia
  • standard_ia
    • +
  • intelligent_tiering
    • +
  • deep_archive
    • -
    The storage class to transition to. Currently there are two supported values - 'glacier', 'onezone_ia', or 'standard_ia'.
    +
    The storage class to transition to.
    The 'standard_ia' class is only being available from Ansible version 2.2.
    @@ -523,7 +527,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.s3_logging_module.rst b/docs/community.aws.s3_logging_module.rst index 545303e4c74..cba4b51503d 100644 --- a/docs/community.aws.s3_logging_module.rst +++ b/docs/community.aws.s3_logging_module.rst @@ -299,7 +299,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.s3_metrics_configuration_module.rst b/docs/community.aws.s3_metrics_configuration_module.rst new file mode 100644 index 00000000000..570d88bd6f3 --- /dev/null +++ b/docs/community.aws.s3_metrics_configuration_module.rst @@ -0,0 +1,372 @@ +.. _community.aws.s3_metrics_configuration_module: + + +************************************** +community.aws.s3_metrics_configuration +************************************** + +**Manage s3 bucket metrics configuration in AWS** + + +Version added: 1.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Manage s3 bucket metrics configuration in AWS which allows to get the CloudWatch request metrics for the objects in a bucket + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 2.6 +- boto + + +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.
    +
    Only used for boto3 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
    +
    +
    + bucket_name + +
    + string + / required +
    +     		+ +
    Name of the s3 bucket
    +
    +
    + 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
    +
    +
    + filter_prefix + +
    + string +
    +     		+ +
    A prefix used when evaluating a metrics filter
    +
    +
    + filter_tags + +
    + dictionary +
    +     		+ +
    A dictionary of one or more tags used when evaluating a metrics filter
    +

    aliases: filter_tag
    +
    +
    + id + +
    + string + / required +
    +     		+ +
    The ID used to identify the metrics configuration
    +
    +
    + profile + +
    + string +
    +     		+ +
    Uses a boto profile. Only works with boto >= 2.24.0.
    +
    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
    +
    +
    + state + +
    + string +
    +     		+
      Choices: +
    • present ←
      • +
    • absent
      • +
    +     		+
    Create or delete metrics configuration
    +
    +
    + validate_certs + +
    + boolean +
    +     		+
      Choices: +
    • no
      • +
    • yes ←
      • +
    +     		+
    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
    +
    +
    + + +Notes +----- + +.. note:: + - This modules manages single metrics configuration, the s3 bucket might have up to 1,000 metrics configurations + - To request metrics for the entire bucket, create a metrics configuration without a filter + - Metrics configurations are necessary only to enable request metric, bucket-level daily storage metrics are always turned on + - 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`` + - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html + - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file + + + +Examples +-------- + +.. code-block:: yaml + + # Note: These examples do not set authentication details, see the AWS Guide for details. + + - name: Create a metrics configuration that enables metrics for an entire bucket + community.aws.s3_metrics_configuration: + bucket_name: my-bucket + id: EntireBucket + state: present + + - name: Put a metrics configuration that enables metrics for objects starting with a prefix + community.aws.s3_metrics_configuration: + bucket_name: my-bucket + id: Assets + filter_prefix: assets + state: present + + - name: Put a metrics configuration that enables metrics for objects with specific tag + community.aws.s3_metrics_configuration: + bucket_name: my-bucket + id: Assets + filter_tag: + kind: asset + state: present + + - name: Put a metrics configuration that enables metrics for objects that start with a particular prefix and have specific tags applied + community.aws.s3_metrics_configuration: + bucket_name: my-bucket + id: ImportantBlueDocuments + filter_prefix: documents + filter_tags: + priority: high + class: blue + state: present + + - name: Delete metrics configuration + community.aws.s3_metrics_configuration: + bucket_name: my-bucket + id: EntireBucket + state: absent + + + + +Status +------ + + +Authors +~~~~~~~ + +- Dmytro Vorotyntsev (@vorotech) diff --git a/docs/community.aws.s3_sync_module.rst b/docs/community.aws.s3_sync_module.rst index 735d89ebb3a..843a11b44dd 100644 --- a/docs/community.aws.s3_sync_module.rst +++ b/docs/community.aws.s3_sync_module.rst @@ -451,7 +451,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: basic upload community.aws.s3_sync: diff --git a/docs/community.aws.s3_website_module.rst b/docs/community.aws.s3_website_module.rst index b4d34254e0c..356cf0315ca 100644 --- a/docs/community.aws.s3_website_module.rst +++ b/docs/community.aws.s3_website_module.rst @@ -316,7 +316,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.sns_module.rst b/docs/community.aws.sns_module.rst index 1e61ff15984..83d5165b902 100644 --- a/docs/community.aws.sns_module.rst +++ b/docs/community.aws.sns_module.rst @@ -440,7 +440,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Send default notification message via SNS community.aws.sns: diff --git a/docs/community.aws.sns_topic_module.rst b/docs/community.aws.sns_topic_module.rst index 100aac00b38..3cf7abcd32f 100644 --- a/docs/community.aws.sns_topic_module.rst +++ b/docs/community.aws.sns_topic_module.rst @@ -385,7 +385,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create alarm SNS topic community.aws.sns_topic: diff --git a/docs/community.aws.sqs_queue_module.rst b/docs/community.aws.sqs_queue_module.rst index 106e2c24083..341f9ca2fc2 100644 --- a/docs/community.aws.sqs_queue_module.rst +++ b/docs/community.aws.sqs_queue_module.rst @@ -5,7 +5,7 @@ community.aws.sqs_queue *********************** -**Creates or deletes AWS SQS queues.** +**Creates or deletes AWS SQS queues** Version added: 1.0.0 @@ -123,12 +123,13 @@ Parameters
    Enables content-based deduplication. Used for FIFOs only.
    +
    Defaults to false.
    @@ -483,7 +484,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create SQS queue with redrive policy community.aws.sqs_queue: diff --git a/docs/community.aws.sts_assume_role_module.rst b/docs/community.aws.sts_assume_role_module.rst index 0de6e76c81b..16b197c2bce 100644 --- a/docs/community.aws.sts_assume_role_module.rst +++ b/docs/community.aws.sts_assume_role_module.rst @@ -345,7 +345,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/docs/community.aws.sts_session_token_module.rst b/docs/community.aws.sts_session_token_module.rst index 432dda4191a..26dae630d73 100644 --- a/docs/community.aws.sts_session_token_module.rst +++ b/docs/community.aws.sts_session_token_module.rst @@ -281,7 +281,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Note: These examples do not set authentication details, see the AWS Guide for details. diff --git a/galaxy.yml b/galaxy.yml index 991e6c90978..65fd909bbaa 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: community name: aws -version: 1.2.1 +version: 1.3.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: '>=1.2.1' + amazon.aws: '>=1.3.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 481ff1020dd..d7efc78d867 100644 --- a/tests/requirements.yml +++ b/tests/requirements.yml @@ -1,7 +1,7 @@ integration_tests_dependencies: -- amazon.aws >= 1.2.1 +- amazon.aws >= 1.3.0 - ansible.windows - community.crypto - community.general unit_tests_dependencies: -- amazon.aws >= 1.2.1 +- amazon.aws >= 1.3.0