amazon.aws.aws_account_attribute lookup – Look up AWS account attributes.
Note
This lookup plugin is part of the amazon.aws collection (version 3.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install amazon.aws
.
You need further requirements to be able to use this lookup plugin,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.aws_account_attribute
.
Synopsis
Describes attributes of your AWS account. You can specify one of the listed attribute choices or omit it to see all attributes.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...)
and query('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
The attribute for which to get the value(s). Choices:
|
|
The AWS access key to use. Configuration:
|
|
The AWS profile Configuration:
|
|
The AWS secret key that corresponds to the access key. Configuration:
|
|
The AWS security token if using temporary access and secret keys. Configuration:
|
|
The region for which to create the connection. Configuration:
|
Examples
vars:
has_ec2_classic: "{{ lookup('aws_account_attribute', attribute='has-ec2-classic') }}"
# true | false
default_vpc_id: "{{ lookup('aws_account_attribute', attribute='default-vpc') }}"
# vpc-xxxxxxxx | none
account_details: "{{ lookup('aws_account_attribute', wantlist='true') }}"
# {'default-vpc': ['vpc-xxxxxxxx'], 'max-elastic-ips': ['5'], 'max-instances': ['20'],
# 'supported-platforms': ['VPC', 'EC2'], 'vpc-max-elastic-ips': ['5'], 'vpc-max-security-groups-per-interface': ['5']}
Return Value
Key |
Description |
---|---|
Returns a boolean when attribute is check_ec2_classic. Otherwise returns the value(s) of the attribute (or all attributes if one is not specified). Returned: success |