diff --git a/plugins/modules/aws_batch_job_definition.py b/plugins/modules/aws_batch_job_definition.py index 4beb1ab2c26..afaaf0c54e8 100644 --- a/plugins/modules/aws_batch_job_definition.py +++ b/plugins/modules/aws_batch_job_definition.py @@ -46,8 +46,9 @@ type: dict image: description: - - The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker - Hub registry are available by default. Other repositories are specified with `` repository-url /image tag ``. + - > + The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker + Hub registry are available by default. Other repositories are specified with C(repository-url/image-name:tag). Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. diff --git a/plugins/modules/aws_config_rule.py b/plugins/modules/aws_config_rule.py index ed4de6ab7e2..a27236d82b0 100644 --- a/plugins/modules/aws_config_rule.py +++ b/plugins/modules/aws_config_rule.py @@ -69,9 +69,9 @@ description: - Provides the source and type of the event that causes AWS Config to evaluate your AWS resources. - This parameter expects a list of dictionaries. Each dictionary expects the following key/value pairs. - - Key `EventSource` The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. - - Key `MessageType` The type of notification that triggers AWS Config to run an evaluation for a rule. - - Key `MaximumExecutionFrequency` The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. + - Key C(EventSource) The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. + - Key C(MessageType) The type of notification that triggers AWS Config to run an evaluation for a rule. + - Key C(MaximumExecutionFrequency) The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. type: dict required: true input_parameters: diff --git a/plugins/modules/aws_secret.py b/plugins/modules/aws_secret.py index 050b00f5ae8..03f4a8d3592 100644 --- a/plugins/modules/aws_secret.py +++ b/plugins/modules/aws_secret.py @@ -40,7 +40,7 @@ kms_key_id: description: - Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be - used to encrypt the `secret_string` or `secret_binary` values in the versions stored in this secret. + used to encrypt the I(secret) values in the versions stored in this secret. type: str secret_type: description: diff --git a/plugins/modules/aws_waf_rule.py b/plugins/modules/aws_waf_rule.py index ce28559b35f..f5701b2ff00 100644 --- a/plugins/modules/aws_waf_rule.py +++ b/plugins/modules/aws_waf_rule.py @@ -63,7 +63,7 @@ description: The name of the condition. The condition must already exist. purge_conditions: description: - - Whether or not to remove conditions that are not passed when updating `conditions`. + - Whether or not to remove conditions that are not passed when updating I(conditions). default: false type: bool waf_regional: diff --git a/plugins/modules/cloudfront_invalidation.py b/plugins/modules/cloudfront_invalidation.py index 4fb602f7a77..0599a71de3e 100644 --- a/plugins/modules/cloudfront_invalidation.py +++ b/plugins/modules/cloudfront_invalidation.py @@ -43,7 +43,7 @@ type: str target_paths: description: - - A list of paths on the distribution to invalidate. Each path should begin with '/'. Wildcards are allowed. eg. '/foo/bar/*' + - A list of paths on the distribution to invalidate. Each path should begin with C(/). Wildcards are allowed. eg. C(/foo/bar/*) required: true type: list elements: str diff --git a/plugins/modules/ec2_placement_group_info.py b/plugins/modules/ec2_placement_group_info.py index 6a344f1d8d9..f4ee9b753b0 100644 --- a/plugins/modules/ec2_placement_group_info.py +++ b/plugins/modules/ec2_placement_group_info.py @@ -45,7 +45,8 @@ register: specific_ec2_placement_groups - ansible.builtin.debug: - msg: "{{ specific_ec2_placement_groups | json_query(\"[?name=='my-cluster']\") }}" + msg: > + {{ specific_ec2_placement_groups | json_query("[?name=='my-cluster']") }} ''' diff --git a/plugins/modules/iam_user.py b/plugins/modules/iam_user.py index 7ec3901aa45..6266d992003 100644 --- a/plugins/modules/iam_user.py +++ b/plugins/modules/iam_user.py @@ -13,7 +13,7 @@ short_description: Manage AWS IAM users description: - A module to manage AWS IAM users. - - The module does not manage groups that users belong to, groups memberships can be managed using `iam_group`. + - The module does not manage groups that users belong to, groups memberships can be managed using M(community.aws.iam_group). author: Josh Souza (@joshsouza) options: name: @@ -104,7 +104,7 @@ EXAMPLES = r''' # 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. -# Groups should manage their membership directly using `iam_group`, +# Groups should manage their membership directly using community.aws.iam_group, # as users belong to them. - name: Create a user diff --git a/plugins/modules/route53_health_check.py b/plugins/modules/route53_health_check.py index 382be93ab6d..22ce36beba8 100644 --- a/plugins/modules/route53_health_check.py +++ b/plugins/modules/route53_health_check.py @@ -60,7 +60,7 @@ fqdn: description: - Domain name of the endpoint to check. Either this or I(ip_address) has - to be provided. When both are given the `fqdn` is used in the `Host:` + to be provided. When both are given the I(fqdn) is used in the C(Host:) header of the HTTP request. type: str string_match: diff --git a/plugins/modules/s3_sync.py b/plugins/modules/s3_sync.py index c9021c3dbf9..75c653f5712 100644 --- a/plugins/modules/s3_sync.py +++ b/plugins/modules/s3_sync.py @@ -83,7 +83,7 @@ include: description: - Shell pattern-style file matching. - - Used before exclude to determine eligible files (for instance, only "*.gif") + - Used before exclude to determine eligible files (for instance, only C("*.gif")) - For multiple patterns, comma-separate them. required: false default: "*" @@ -91,7 +91,7 @@ exclude: description: - Shell pattern-style file matching. - - Used after include to remove files (for instance, skip "*.txt") + - Used after include to remove files (for instance, skip C("*.txt")) - For multiple patterns, comma-separate them. required: false default: ".*"