diff --git a/docs/community.aws.aws_codebuild_module.rst b/docs/community.aws.aws_codebuild_module.rst index fc5baac090d..90ec6e64396 100644 --- a/docs/community.aws.aws_codebuild_module.rst +++ b/docs/community.aws.aws_codebuild_module.rst @@ -48,13 +48,13 @@ Parameters
dictionary - / required
Information about the build output artifacts for the build project.
+
artifacts is required when creating a new project.
@@ -477,6 +477,27 @@ Parameters

aliases: aws_profile
+ + +
+ purge_tags + +
+ boolean +
+ + + + + +
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
+
If the resource_tags parameter is not set then tags will not be modified, even if purge_tags=True.
+
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
+ +
@@ -493,6 +514,23 @@ Parameters

aliases: aws_region, ec2_region
+ + +
+ resource_tags + +
+ dictionary +
+ + + + +
A dictionary representing the tags to be applied to the build project.
+
If the resource_tags parameter is not set then tags will not be modified.
+
Mutually exclusive with the tags parameter.
+ +
@@ -534,13 +572,13 @@ Parameters
dictionary - / required
Configure service and location for the build input source.
+
source is required when creating a new project.
@@ -662,6 +700,8 @@ Parameters
A set of tags for the build project.
+
Mutually exclusive with the resource_tags parameter.
+
In release 6.0.0 this parameter will accept a simple dictionary instead of the list of dictionaries format. To use the simple dictionary format prior to release 6.0.0 the resource_tags can be used instead of tags.
@@ -980,6 +1020,24 @@ Common return values are documented `here my_project + +   + +
+ reource_tags + +
+ dictionary +
+
added in 4.0.0
+ + when configured + +
A simple dictionary representing the tags added to the project.
+
tags and reource_tags represent the same information in different formats.
+
+ +   @@ -1131,7 +1189,8 @@ Common return values are documented `here when configured -
Tags added to the project
+
Tags added to the project in the boto3 list of dictionaries format.
+
tags and reource_tags represent the same information in different formats.

diff --git a/docs/community.aws.ec2_customer_gateway_module.rst b/docs/community.aws.ec2_customer_gateway_module.rst index 3119afec5f3..cea98a5f370 100644 --- a/docs/community.aws.ec2_customer_gateway_module.rst +++ b/docs/community.aws.ec2_customer_gateway_module.rst @@ -123,7 +123,8 @@ Parameters -
Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present.
+
Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+
Defaults to 65000 if not specified when state=present.
diff --git a/docs/community.aws.ecs_service_info_module.rst b/docs/community.aws.ecs_service_info_module.rst index 107fdc51d26..b9fc341ef43 100644 --- a/docs/community.aws.ecs_service_info_module.rst +++ b/docs/community.aws.ecs_service_info_module.rst @@ -265,6 +265,7 @@ Parameters
One or more services to get details for
+

aliases: name
diff --git a/docs/community.aws.ecs_service_module.rst b/docs/community.aws.ecs_service_module.rst index ed5945a09c7..73fae608aaa 100644 --- a/docs/community.aws.ecs_service_module.rst +++ b/docs/community.aws.ecs_service_module.rst @@ -37,12 +37,12 @@ Parameters - + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
aws_access_key @@ -60,7 +60,7 @@ Parameters
+
aws_ca_bundle @@ -77,7 +77,7 @@ Parameters
+
aws_config @@ -94,7 +94,7 @@ Parameters
+
aws_secret_key @@ -112,7 +112,7 @@ Parameters
+
client_token @@ -127,7 +127,7 @@ Parameters
+
cluster @@ -136,13 +136,15 @@ Parameters 		+ Default:
"default"
The name of the cluster in which the service exists.
+
If not specified, the cluster name will be default.
+
debug_botocore_endpoint_logs @@ -161,7 +163,7 @@ Parameters
+
delay @@ -177,7 +179,7 @@ Parameters
+
deployment_configuration @@ -194,7 +196,66 @@ Parameters
+
+ deployment_circuit_breaker + +
+ dictionary +
+ 		+ +
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state.
+
+
+ enable + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
If enabled, a service deployment will transition to a failed state and stop launching new tasks.
+
+
+ rollback + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
If enabled, ECS will roll back your service to the last completed deployment after a failure.
+
maximum_percent @@ -210,7 +271,7 @@ Parameters
+
minimum_healthy_percent @@ -226,7 +287,7 @@ Parameters
+
desired_count @@ -242,7 +303,7 @@ Parameters
+
ec2_url @@ -258,7 +319,7 @@ Parameters
+
force_deletion @@ -278,7 +339,7 @@ Parameters
+
force_new_deployment @@ -297,7 +358,7 @@ Parameters
+
health_check_grace_period_seconds @@ -312,7 +373,7 @@ Parameters
+
launch_type @@ -331,7 +392,7 @@ Parameters
+
load_balancers @@ -347,7 +408,7 @@ Parameters
+
name @@ -360,10 +421,11 @@ Parameters
The name of the service.
+

aliases: service
+
network_configuration @@ -379,7 +441,7 @@ Parameters
+
assign_public_ip @@ -399,7 +461,7 @@ Parameters
+
security_groups @@ -416,7 +478,7 @@ Parameters
+
subnets @@ -433,7 +495,7 @@ Parameters
+
placement_constraints @@ -451,7 +513,7 @@ Parameters
+
expression @@ -467,7 +529,7 @@ Parameters
+
type @@ -483,7 +545,7 @@ Parameters
+
placement_strategy @@ -500,7 +562,7 @@ Parameters
+
field @@ -516,7 +578,7 @@ Parameters
+
type @@ -532,7 +594,7 @@ Parameters
+
platform_version @@ -549,7 +611,7 @@ Parameters
+
profile @@ -566,7 +628,7 @@ Parameters
+
region @@ -582,7 +644,7 @@ Parameters
+
repeat @@ -598,7 +660,7 @@ Parameters
+
role @@ -614,7 +676,7 @@ Parameters
+
scheduling_strategy @@ -634,7 +696,7 @@ Parameters
+
security_token @@ -653,7 +715,7 @@ Parameters
+
service_registries @@ -670,7 +732,7 @@ Parameters
+
arn @@ -686,7 +748,7 @@ Parameters
+
container_name @@ -702,7 +764,7 @@ Parameters
+
container_port @@ -718,7 +780,7 @@ Parameters
+
state @@ -739,7 +801,7 @@ Parameters
+
task_definition @@ -755,7 +817,7 @@ Parameters
+
validate_certs @@ -851,13 +913,13 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a .. raw:: html - - + + - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - diff --git a/docs/community.aws.ecs_task_module.rst b/docs/community.aws.ecs_task_module.rst index fc8c5c0fb3d..df277e5860d 100644 --- a/docs/community.aws.ecs_task_module.rst +++ b/docs/community.aws.ecs_task_module.rst @@ -118,13 +118,14 @@ Parameters
string - / required
diff --git a/docs/community.aws.efs_tag_module.rst b/docs/community.aws.efs_tag_module.rst index c0d7ffe308b..afe5dde4c04 100644 --- a/docs/community.aws.efs_tag_module.rst +++ b/docs/community.aws.efs_tag_module.rst @@ -269,6 +269,7 @@ Parameters diff --git a/docs/community.aws.iam_server_certificate_info_module.rst b/docs/community.aws.iam_server_certificate_info_module.rst index f1e90f5278b..b918708d7cc 100644 --- a/docs/community.aws.iam_server_certificate_info_module.rst +++ b/docs/community.aws.iam_server_certificate_info_module.rst @@ -308,7 +308,9 @@ Common return values are documented `here The asn1der encoded PEM string
Sample:
-
-----BEGIN CERTIFICATE----- bunch of random data -----END CERTIFICATE-----
+
-----BEGIN CERTIFICATE----- + bunch of random data + -----END CERTIFICATE-----
 diff --git a/docs/community.aws.lambda_info_module.rst b/docs/community.aws.lambda_info_module.rst index 950a831996d..8f5eca8beb4 100644 --- a/docs/community.aws.lambda_info_module.rst +++ b/docs/community.aws.lambda_info_module.rst @@ -18,7 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Gathers various details related to Lambda functions, including aliases, versions and event source mappings. -- Use module :ref:`community.aws.lambda ` to manage the lambda function itself, :ref:`community.aws.lambda_alias ` to manage function aliases and :ref:`community.aws.lambda_event ` to manage lambda event source mappings. +- Use module :ref:`community.aws.lambda ` to manage the lambda function itself, :ref:`community.aws.lambda_alias ` to manage function aliases, :ref:`community.aws.lambda_event ` to manage lambda event source mappings, and :ref:`community.aws.lambda_policy ` to manage policy statements. @@ -207,7 +207,7 @@ Parameters @@ -300,17 +302,20 @@ Examples query: all function_name: myFunction register: my_function_details + # List all versions of a function - name: List function versions community.aws.lambda_info: query: versions function_name: myFunction register: my_function_versions - # List all lambda function versions - - name: List all function + + # List all info for all functions + - name: List all functions community.aws.lambda_info: query: all register: output + - name: show Lambda information ansible.builtin.debug: msg: "{{ output['function'] }}" diff --git a/docs/community.aws.rds_instance_module.rst b/docs/community.aws.rds_instance_module.rst index 4892937d38d..39b8e294acb 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -91,7 +91,7 @@ Parameters @@ -125,7 +125,7 @@ Parameters @@ -213,7 +213,7 @@ Parameters @@ -243,7 +243,7 @@ Parameters @@ -392,7 +392,8 @@ Parameters @@ -529,7 +530,7 @@ Parameters @@ -648,7 +649,7 @@ Parameters @@ -779,7 +780,7 @@ Parameters @@ -859,7 +860,7 @@ Parameters @@ -1149,7 +1150,7 @@ Parameters @@ -1265,22 +1266,7 @@ Parameters - - - - - @@ -1423,7 +1409,7 @@ Parameters @@ -1526,7 +1512,7 @@ Parameters @@ -1545,7 +1531,7 @@ Parameters
Fact
Fact Returned Description
+
service @@ -874,7 +936,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
clusterArn @@ -891,7 +953,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
deploymentConfiguration @@ -909,7 +971,64 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
+ deploymentCircuitBreaker + +
+ complex +
+ 		always +
dictionary of deploymentCircuitBreaker +
+
+
+
+ enable + +
+ boolean +
+ 		always +
The state of the circuit breaker feature. +
+
+
+
+ rollback + +
+ boolean +
+ 		always +
The state of the rollback feature of the circuit breaker. +
+
+
maximumPercent @@ -927,7 +1046,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
minimumHealthyPercent @@ -945,7 +1064,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
deployments @@ -963,7 +1082,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
desiredCount @@ -980,7 +1099,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
events @@ -998,7 +1117,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
loadBalancers @@ -1016,7 +1135,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
containerName @@ -1034,7 +1153,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
containerPort @@ -1052,7 +1171,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
loadBalancerName @@ -1070,7 +1189,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
pendingCount @@ -1087,7 +1206,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
placementConstraints @@ -1106,7 +1225,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
expression @@ -1124,7 +1243,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
type @@ -1142,7 +1261,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
placementStrategy @@ -1161,7 +1280,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
field @@ -1179,7 +1298,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
type @@ -1197,7 +1316,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
runningCount @@ -1214,7 +1333,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
serviceArn @@ -1231,7 +1350,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
serviceName @@ -1248,7 +1367,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
status @@ -1265,7 +1384,7 @@ Facts returned by this module are added/updated in the ``hostvars`` host facts a
+
taskDefinition @@ -1293,12 +1412,12 @@ Common return values are documented `here
KeyKey Returned Description
+
service @@ -1314,7 +1433,7 @@ Common return values are documented `here
  +
clusterArn @@ -1330,7 +1449,7 @@ Common return values are documented `here
  +
deploymentConfiguration @@ -1347,7 +1466,61 @@ Common return values are documented `here 		    +
+ deploymentCircuitBreaker + +
+ complex +
+ 		always +
dictionary of deploymentCircuitBreaker
+
+
    +
+ enable + +
+ boolean +
+ 		always +
The state of the circuit breaker feature.
+
+
    +
+ rollback + +
+ boolean +
+ 		always +
The state of the rollback feature of the circuit breaker.
+
+
  
maximumPercent @@ -1364,7 +1537,7 @@ Common return values are documented `here 		    +
minimumHealthyPercent @@ -1381,7 +1554,7 @@ Common return values are documented `here 		  +
deployments @@ -1398,7 +1571,7 @@ Common return values are documented `here
  +
desiredCount @@ -1414,7 +1587,7 @@ Common return values are documented `here
  +
events @@ -1431,7 +1604,7 @@ Common return values are documented `here
  +
loadBalancers @@ -1448,7 +1621,7 @@ Common return values are documented `here 		    +
containerName @@ -1465,7 +1638,7 @@ Common return values are documented `here 		    +
containerPort @@ -1482,7 +1655,7 @@ Common return values are documented `here 		    +
loadBalancerName @@ -1499,7 +1672,7 @@ Common return values are documented `here 		  +
pendingCount @@ -1515,7 +1688,7 @@ Common return values are documented `here
  +
placementConstraints @@ -1533,7 +1706,7 @@ Common return values are documented `here 		    +
expression @@ -1550,7 +1723,7 @@ Common return values are documented `here 		    +
type @@ -1567,7 +1740,7 @@ Common return values are documented `here 		  +
placementStrategy @@ -1585,7 +1758,7 @@ Common return values are documented `here 		    +
field @@ -1602,7 +1775,7 @@ Common return values are documented `here 		    +
type @@ -1619,7 +1792,7 @@ Common return values are documented `here 		  +
runningCount @@ -1635,7 +1808,7 @@ Common return values are documented `here
  +
serviceArn @@ -1651,7 +1824,7 @@ Common return values are documented `here
  +
serviceName @@ -1667,7 +1840,7 @@ Common return values are documented `here
  +
status @@ -1683,7 +1856,7 @@ Common return values are documented `here
  +
taskDefinition diff --git a/docs/community.aws.ecs_tag_module.rst b/docs/community.aws.ecs_tag_module.rst index cb408a3855f..552387d20b6 100644 --- a/docs/community.aws.ecs_tag_module.rst +++ b/docs/community.aws.ecs_tag_module.rst @@ -306,6 +306,7 @@ Parameters
A dictionary of tags to add or remove from the resource.
If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
+

aliases: resource_tags
+ Default:
"default"
The name of the cluster to run the task on.
+
If not specified, the cluster name will be default.
A dictionary of tags to add or remove from the resource.
If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
+

aliases: resource_tags
    Choices:
  • aliases
    • -
  • all ←
    • +
  • all
  • config
  • mappings
  • policy
    • @@ -216,7 +216,9 @@ Parameters
-
Specifies the resource type for which to gather information. Leave blank to retrieve all information.
+
Specifies the resource type for which to gather information.
+
Defaults to all when function_name is specified.
+
Defaults to config when function_name is NOT specified.
-
A value that specifies whether modifying a cluster with new_db_instance_identifier and master_user_password should be applied as soon as possible, regardless of the preferred_maintenance_window setting. If false, changes are applied during the next maintenance window.
+
A value that specifies whether modifying an instance with new_db_instance_identifier and master_user_password should be applied as soon as possible, regardless of the preferred_maintenance_window setting. If false, changes are applied during the next maintenance window.
-
A list of EC2 Availability Zones that instances in the DB cluster can be created in. May be used when creating a cluster or when restoring from S3 or a snapshot. Mutually exclusive with multi_az.
+
A list of EC2 Availability Zones that the DB instance can be created in. May be used when creating an instance or when restoring from S3 or a snapshot. Mutually exclusive with multi_az.

aliases: az, zone
The number of days for which automated backups are retained.
When set to 0, automated backups will be disabled. (Not applicable if the DB instance is a source to read replicas)
-
May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.
+
May be used when creating a new instance, when restoring from S3, or when modifying an instance.
-
The character set to associate with the DB cluster.
+
The character set to associate with the DB instance.
-
The identifier for the DB snapshot to restore from if using creation_source=snapshot.
+
The identifier or ARN of the DB snapshot to restore from when using creation_source=snapshot.
+

aliases: snapshot_identifier, snapshot_id
-
Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. If this option is omitted when creating the cluster, Amazon RDS sets this to False.
+
Enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. If this option is omitted when creating the instance, Amazon RDS sets this to False.
-
Set to True to update your cluster password with master_user_password. Since comparing passwords to determine if it needs to be updated is not possible this is set to False by default to allow idempotence.
+
Set to True to update your instance password with master_user_password. Since comparing passwords to determine if it needs to be updated is not possible this is set to False by default to allow idempotence.
-
The name of the master user for the DB cluster. Must be 1-16 letters or numbers and begin with a letter.
+
The name of the master user for the DB instance. Must be 1-16 letters or numbers and begin with a letter.

aliases: username
-
The new DB cluster (lowercase) identifier for the DB cluster when renaming a DB instance. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens. Use apply_immediately to rename immediately, otherwise it is updated during the next maintenance window.
+
The new DB instance (lowercase) identifier for the DB instance when renaming a DB instance. The identifier must contain from 1 to 63 letters, numbers, or hyphens and the first character must be a letter and may not end in a hyphen or contain consecutive hyphens. Use apply_immediately to rename immediately, otherwise it is updated during the next maintenance window.

aliases: new_instance_id, new_id
-
Set to False to promote a read replica cluster or true to create one. When creating a read replica creation_source should be set to 'instance' or not provided. source_db_instance_identifier must be provided with this option.
+
Set to False to promote a read replica instance or true to create one. When creating a read replica creation_source should be set to 'instance' or not provided. source_db_instance_identifier must be provided with this option.
-
Whether a final DB cluster snapshot is created before the DB cluster is deleted. If this is false final_db_snapshot_identifier must be provided.
-
-
- snapshot_identifier - -
- string -
- 		- -
The ARN of the DB snapshot to restore from when using creation_source=snapshot.
+
Whether a final DB instance snapshot is created before the DB instance is deleted. If this is false final_db_snapshot_identifier must be provided.
-
A dictionary of key value pairs to assign the DB cluster.
+
A dictionary of key value pairs to assign the DB instance.
-
A list of EC2 VPC security groups to associate with the DB cluster.
+
A list of EC2 VPC security groups to associate with the DB instance.
-
Whether to wait for the cluster to be available, stopped, or deleted. At a later time a wait_timeout option may be added. Following each API call to create/modify/delete the instance a waiter is used with a 60 second delay 30 times until the instance reaches the expected state (available/stopped/deleted). The total task time may also be influenced by AWSRetry which helps stabilize if the instance is in an invalid state to operate on to begin with (such as if you try to stop it when it is in the process of rebooting). If setting this to False task retries and delays may make your playbook execution better handle timeouts for major modifications.
+
Whether to wait for the instance to be available, stopped, or deleted. At a later time a wait_timeout option may be added. Following each API call to create/modify/delete the instance a waiter is used with a 60 second delay 30 times until the instance reaches the expected state (available/stopped/deleted). The total task time may also be influenced by AWSRetry which helps stabilize if the instance is in an invalid state to operate on to begin with (such as if you try to stop it when it is in the process of rebooting). If setting this to False task retries and delays may make your playbook execution better handle timeouts for major modifications.
@@ -1644,14 +1630,26 @@ Examples community.aws.rds_instance: id: "my-instance-id" state: present - engine: postgres - engine_version: 14.2 - username: "{{ username }}" - password: "{{ password }}" - db_instance_class: db.m6g.large - allocated_storage: "{{ allocated_storage }}" purge_iam_roles: yes + # Restore DB instance from snapshot + - name: Create a snapshot and wait until completion + community.aws.rds_instance_snapshot: + instance_id: 'my-instance-id' + snapshot_id: 'my-new-snapshot' + state: present + wait: yes + register: snapshot + + - name: Restore DB from snapshot + community.aws.rds_instance: + id: 'my-restored-db' + creation_source: snapshot + snapshot_identifier: 'my-new-snapshot' + engine: mariadb + state: present + register: restored_db + Return Values diff --git a/docs/community.aws.wafv2_web_acl_module.rst b/docs/community.aws.wafv2_web_acl_module.rst index ba88b68acfa..785b5743ee3 100644 --- a/docs/community.aws.wafv2_web_acl_module.rst +++ b/docs/community.aws.wafv2_web_acl_module.rst @@ -147,7 +147,7 @@ Parameters
A map of custom response keys and content bodies. Define response bodies here and reference them in the rules by providing
the key of the body dictionary element.
Each element must have a unique dict key and in the dict two keys for content_type and content.
-
Requires botocore >= 1.21.0
+
Requires botocore >= 1.20.40