Index of all Collection Environment Variables
The following index documents all environment variables declared by plugins in collections. Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.
- ANSIBLE_INVENTORY_USE_EXTRA_VARS
Merge extra vars into the available variables for composition (highest precedence).
- AWS_ACCESS_KEY
AWS access key ID.
See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.
The aws_access_key and profile options are mutually exclusive.
The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
- AWS_ACCESS_KEY_ID
See the documentations for the options where this environment variable is used.
Used by: community.aws.aws_mq inventory plugin, community.aws.aws_ssm connection plugin
- AWS_DEFAULT_PROFILE
A named AWS profile to use for authentication.
See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.
The profile option is mutually exclusive with the aws_access_key, aws_secret_key and session_token options.
- AWS_DEFAULT_REGION
The region the EC2 instance is located.
- AWS_PROFILE
See the documentations for the options where this environment variable is used.
Used by: community.aws.aws_mq inventory plugin, community.aws.aws_ssm connection plugin
- AWS_REGION
See the documentations for the options where this environment variable is used.
Used by: community.aws.aws_mq inventory plugin, community.aws.aws_ssm connection plugin
- AWS_SECRET_ACCESS_KEY
See the documentations for the options where this environment variable is used.
Used by: community.aws.aws_mq inventory plugin, community.aws.aws_ssm connection plugin
- AWS_SECRET_KEY
AWS secret access key.
See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.
The secret_key and profile options are mutually exclusive.
The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
- AWS_SESSION_TOKEN
See the documentations for the options where this environment variable is used.
Used by: community.aws.aws_mq inventory plugin, community.aws.aws_ssm connection plugin
- AWS_URL
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.