amazon.aws.kms_key_info module – Gather information about AWS KMS keys

Note

This module is part of the amazon.aws collection (version 9.1.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 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.28.0

  • botocore >= 1.31.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

alias

aliases: key_alias

string

added in community.aws 1.4.0

Alias for key.

Mutually exclusive with key_id and filters.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

debug_botocore_endpoint_logs

boolean

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:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

filters

dictionary

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

Mutually exclusive with alias and key_id.

key_id

aliases: key_arn

string

added in community.aws 1.4.0

Key ID or ARN of the key.

Mutually exclusive with alias and filters.

pending_deletion

boolean

Whether to get full details (tags, grants etc.) of keys pending deletion.

Choices:

  • false ← (default)

  • true

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

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

kms_keys

complex

List of keys.

Returned: always

aliases

list / elements=string

List of aliases associated with the key.

Returned: always

Sample: ["aws/acm", "aws/ebs"]

aws_account_id

string

The AWS Account ID that the key belongs to.

Returned: always

Sample: "123456789012"

creation_date

string

Date and time of creation of the key.

Returned: always

Sample: "2017-04-18T15:12:08.551000+10:00"

customer_master_key_spec

string

Describes the type of key material in the KMS key.

Returned: always

Sample: "SYMMETRIC_DEFAULT"

deletion_date

string

added in community.aws 3.3.0

Date and time after which KMS deletes this KMS key.

Returned: when kms_keys.key_state is PendingDeletion

Sample: "2017-04-18T15:12:08.551000+10:00"

description

string

Description of the key.

Returned: always

Sample: "My Key for Protecting important stuff"

enable_key_rotation

boolean

Whether the automatic annual key rotation is enabled. Returns None if key rotation status can’t be determined.

Returned: always

Sample: false

enabled

boolean

Whether the key is enabled. True if kms_keys.key_state is Enabled.

Returned: always

Sample: false

encryption_algorithms

list / elements=string

The encryption algorithms that the KMS key supports.

Returned: always

Sample: ["SYMMETRIC_DEFAULT"]

grants

list / elements=dictionary

List of grants associated with a key.

Returned: always

constraints

dictionary

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: {"encryption_context_equals": {"aws:lambda:_function_arn": "arn:aws:lambda:ap-southeast-2:123456789012:function:xyz"}}

creation_date

string

Date of creation of the grant.

Returned: always

Sample: "2017-04-18T15:12:08+10:00"

grant_id

string

The unique ID for the grant.

Returned: always

Sample: "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234"

grantee_principal

string

The principal that receives the grant’s permissions.

Returned: always

Sample: "arn:aws:sts::123456789012:assumed-role/lambda_xyz/xyz"

issuing_account

string

The AWS account under which the grant was issued.

Returned: always

Sample: "arn:aws:iam::123456789012:root"

key_id

string

The key ARN to which the grant applies.

Returned: always

Sample: "arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890"

name

string

The friendly name that identifies the grant.

Returned: always

Sample: "xyz"

operations

list / elements=string

The list of operations permitted by the grant.

Returned: always

Sample: ["Decrypt", "GenerateDataKey"]

retiring_principal

string

The principal that can retire the grant.

Returned: always

Sample: "arn:aws:sts::123456789012:assumed-role/lambda_xyz/xyz"

key_arn

string

ARN of key.

Returned: always

Sample: "arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890"

key_id

string

ID of key.

Returned: always

Sample: "abcd1234-abcd-1234-5678-ef1234567890"

key_manager

string

The manager of the KMS key.

Returned: always

Sample: "AWS"

key_policies

list / elements=dictionary

added in community.aws 3.3.0

List of policy documents for the key. Empty when access is denied even if there are policies.

Returned: always

Sample: {"Id": "auto-ebs-2", "Statement": [{"Action": ["kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:CreateGrant", "kms:DescribeKey"], "Condition": {"StringEquals": {"kms:CallerAccount": "123456789012", "kms:ViaService": "ec2.ap-southeast-2.amazonaws.com"}}, "Effect": "Allow", "Principal": {"AWS": "*"}, "Resource": "*", "Sid": "Allow access through EBS for all principals in the account that are authorized to use EBS"}, {"Action": ["kms:Describe*", "kms:Get*", "kms:List*", "kms:RevokeGrant"], "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Resource": "*", "Sid": "Allow direct access to key metadata to the account"}], "Version": "2012-10-17"}

key_spec

string

Specifies the type of KMS key to create.

Returned: always

Sample: "SYMMETRIC_DEFAULT"

key_state

string

The state of the key.

Will be one of 'Creating', 'Enabled', 'Disabled', 'PendingDeletion', 'PendingImport', 'PendingReplicaDeletion', 'Unavailable', or 'Updating'.

Returned: always

Sample: "PendingDeletion"

key_usage

string

The cryptographic operations for which you can use the key.

Returned: always

Sample: "ENCRYPT_DECRYPT"

multi_region

boolean

Indicates whether the KMS key is a multi-Region (True) or regional (False) key.

Returned: always

Sample: false

origin

string

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.

Returned: always

Sample: "AWS_KMS"

tags

dictionary

Dictionary of tags applied to the key. Empty when access is denied even if there are tags.

Returned: always

Sample: {"Name": "myKey", "Purpose": "protecting_stuff"}

Authors

  • Will Thames (@willthames)