community.aws.aws_kms_info module – Gather information about AWS KMS keys
Note
This module is part of the community.aws collection (version 3.6.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 community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.aws_kms_info
.
New in community.aws 1.0.0
Synopsis
Gather information about AWS KMS keys including tags and grants
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
Alias for key. Mutually exclusive with key_id and filters. |
|
If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
Use a botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices:
|
|
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. |
|
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 ( Mutually exclusive with alias and key_id. |
|
Key ID or ARN of the key. Mutually exclusive with alias and filters. |
|
Returning the This parameter now does nothing, and after version Choices:
|
|
Whether to get full details (tags, grants etc.) of keys pending deletion Choices:
|
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
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 |
|
If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. Aliases aws_session_token and session_token have been added in version 3.2.0. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather information about all KMS keys
- community.aws.aws_kms_info:
# Gather information about all keys with a Name tag
- community.aws.aws_kms_info:
filters:
tag-key: Name
# Gather information about all keys with a specific name
- community.aws.aws_kms_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 of creation of the key Returned: always Sample: |
|
Description of the key Returned: always Sample: |
|
Whether the automatically key rotation every year is enabled. Returns None if key rotation status can’t be determined. Returned: always Sample: |
|
Whether the key is enabled. True if 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: |
|
list of policy documents for the key. Empty when access is denied even if there are policies. Returned: always Sample: |
|
The state of the key Returned: always Sample: |
|
The cryptographic operations for which you can use the key. Returned: always Sample: |
|
The source of the key’s key material. When this value is Returned: always Sample: |
|
list of policy documents for the key. Empty when access is denied even if there are policies. Returned: always Sample: |
|
dictionary of tags applied to the key. Empty when access is denied even if there are tags. Returned: always Sample: |