amazon.aws.kms_key_info module – Gather information about AWS KMS keys
Note
This module is part of the amazon.aws collection (version 8.2.1).
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 module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.kms_key_info
.
New in amazon.aws 5.0.0
Synopsis
Gather information about AWS KMS keys including tags and grants.
Prior to release 5.0.0 this module was called community.aws.aws_kms_info. The usage did not change.
This module was originally added to
community.aws
in release 1.0.0.
Aliases: aws_kms_info
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
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 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. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
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. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
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 ( |
|
Whether to get full details (tags, grants etc.) of keys pending deletion. Choices:
|
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. 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 The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
The
policies
return key was removed in amazon.aws release 8.0.0.Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather information about all KMS keys
- amazon.aws.kms_key_info:
# Gather information about all keys with a Name tag
- amazon.aws.kms_key_info:
filters:
tag-key: Name
# Gather information about all keys with a specific name
- amazon.aws.kms_key_info:
filters:
"tag:Name": Example
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of keys. Returned: always |
|
List of aliases associated with the key. Returned: always Sample: |
|
The AWS Account ID that the key belongs to. Returned: always Sample: |
|
Date and time of creation of the key. Returned: always Sample: |
|
Describes the type of key material in the KMS key. Returned: always Sample: |
|
Date and time after which KMS deletes this KMS key. Returned: when Sample: |
|
Description of the key. Returned: always Sample: |
|
Whether the automatic annual key rotation is enabled. Returns None if key rotation status can’t be determined. Returned: always Sample: |
|
The encryption algorithms that the KMS key supports. Returned: always Sample: |
|
List of grants associated with a key. Returned: 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 Returned: always Sample: |
|
Date of creation of the grant. Returned: always Sample: |
|
The unique ID for the grant. Returned: always Sample: |
|
The principal that receives the grant’s permissions. Returned: always Sample: |
|
The AWS account under which the grant was issued. Returned: always Sample: |
|
The key ARN to which the grant applies. Returned: always Sample: |
|
The friendly name that identifies the grant. Returned: always Sample: |
|
The list of operations permitted by the grant. Returned: always Sample: |
|
The principal that can retire the grant. Returned: always Sample: |
|
ARN of key. Returned: always Sample: |
|
ID of key. Returned: always Sample: |
|
The manager of the KMS key. Returned: always Sample: |
|
List of policy documents for the key. Empty when access is denied even if there are policies. Returned: always Sample: |
|
Specifies the type of KMS key to create. Returned: always Sample: |
|
The state of the key. Will be one of Returned: always Sample: |
|
The cryptographic operations for which you can use the key. Returned: always Sample: |
|
Indicates whether the KMS key is a multi-Region (True) or regional (False) key. Returned: always Sample: |
|
The source of the key’s key material. When this value is Returned: always Sample: |
|
Dictionary of tags applied to the key. Empty when access is denied even if there are tags. Returned: always Sample: |