New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key | |
aws_secret_key | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key | |
ec2_url | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
filters | A dict of filters to apply. Each dict item consists of a filter key and a filter value. The filters aren't natively supported by boto3, but are supported to provide similar functionality to other modules. Standard tag filters ( tag-key , tag-value and tag:tagName ) are available, as are key-id and alias
| |
pending_deletion | Default: no | Whether to get full details (tags, grants etc.) of keys pending deletion |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
security_token (added in 1.6) | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token | |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
AWS_URL
or EC2_URL
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about all KMS keys - aws_kms_facts # Gather facts about all keys with a Name tag - aws_kms_facts: filters: tag-key: Name # Gather facts about all keys with a specific name - aws_kms_facts: filters: "tag:Name": Example
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
keys complex | always | list of keys | ||
origin str | always | The source of the key's key material. When this value is AWS_KMS , AWS KMS created the key material. When this value is EXTERNAL , the key material was imported or the CMK lacks key material.Sample: AWS_KMS | ||
description str | always | Description of the key Sample: My Key for Protecting important stuff | ||
tags dict | always | dictionary of tags applied to the key. Empty when access is denied even if there are tags. Sample: {'Name': 'myKey', 'Purpose': 'protecting_stuff'} | ||
enabled str | always | Whether the key is enabled. True if KeyState is true. | ||
creation_date str | always | Date of creation of the key Sample: 2017-04-18 05:12:08.551000 | ||
grants complex | always | list of grants associated with a key | ||
operations list | always | The list of operations permitted by the grant Sample: ['Decrypt', 'RetireGrant'] | ||
name str | always | The friendly name that identifies the grant Sample: xyz | ||
issuing_account str | always | The AWS account under which the grant was issued Sample: arn:aws:iam::01234567890:root | ||
grant_id str | always | The unique ID for the grant Sample: abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234 | ||
grantee_principal str | always | The principal that receives the grant's permissions Sample: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz | ||
creation_date str | always | Date of creation of the grant Sample: 2017-04-18 05:12:08 | ||
key_id str | always | The key ARN to which the grant applies. Sample: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890 | ||
retiring_principal str | always | The principal that can retire the grant Sample: arn:aws:sts::0123456789012:assumed-role/lambda_xyz/xyz | ||
constraints dict | always | Constraints on the encryption context that the grant allows. See https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html for further details Sample: {'encryption_context_equals': {'aws:lambda:_function_arn': 'arn:aws:lambda:ap-southeast-2:012345678912:function:xyz'}} | ||
key_usage str | always | The cryptographic operations for which you can use the key. Sample: ENCRYPT_DECRYPT | ||
policies list | always | list of policy documents for the keys. Empty when access is denied even if there are policies. Sample: {'Version': '2012-10-17', 'Id': 'auto-ebs-2', 'Statement': [{'Resource': '*', 'Sid': 'Allow access through EBS for all principals in the account that are authorized to use EBS', 'Action': ['kms:Encrypt', 'kms:Decrypt', 'kms:ReEncrypt*', 'kms:GenerateDataKey*', 'kms:CreateGrant', 'kms:DescribeKey'], 'Effect': 'Allow', 'Condition': {'StringEquals': {'kms:ViaService': 'ec2.ap-southeast-2.amazonaws.com', 'kms:CallerAccount': '111111111111'}}, 'Principal': {'AWS': '*'}}, {'Action': ['kms:Describe*', 'kms:Get*', 'kms:List*', 'kms:RevokeGrant'], 'Sid': 'Allow direct access to key metadata to the account', 'Resource': '*', 'Effect': 'Allow', 'Principal': {'AWS': 'arn:aws:iam::111111111111:root'}}]} | ||
key_id str | always | ID of key Sample: abcd1234-abcd-1234-5678-ef1234567890 | ||
key_arn str | always | ARN of key Sample: arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890 | ||
aws_account_id str | always | The AWS Account ID that the key belongs to Sample: 1234567890123 | ||
key_state str | always | The state of the key Sample: PendingDeletion | ||
aliases list | always | list of aliases associated with the key Sample: ['aws/acm', 'aws/ebs'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aws_kms_facts_module.html