Skip to content

Commit

Permalink
Add documentation for the use of strings with compose
Browse files Browse the repository at this point in the history
Documentation for the use of strings with compose is documented in
https://docs.ansible.com/ansible/latest/plugins/inventory.html#using-inventory-plugins
 . This documentation and example should be provided in the invetory
 module as well.

 Related to ansible-collections#570
  • Loading branch information
mjmayer committed Nov 22, 2022
1 parent beeeccb commit 5ffe33e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/docsite/rst/aws_ec2_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,18 @@ Some examples are shown below:
# This sets the ec2_security_group_ids variable.
ec2_security_group_ids: security_groups | map(attribute='group_id') | list | join(',')
# This sets several host variables that can be used in conjunction with the SSM connection module.
# Strings must be wrapped in two sets of quotes, either ' then " or " then '.
ansible_aws_ssm_instance_id: instance_id
ansible_connection: '"community.aws.aws_ssm"'
ansible_user: '"ssm-user"'
ansible_become: true
ansible_aws_ssm_region: '"us-west-2"'
ansible_aws_ssm_bucket_name: '"my-ansible-ssm-bucket"'
ansible_aws_ssm_bucket_sse_mode: '"AES256"'
ansible_aws_ssm_timeout: 600
ansible_aws_ssm_retries: 10
``include_filters`` and ``exclude_filters``
-------------------------------------------
Expand Down

0 comments on commit 5ffe33e

Please sign in to comment.