amazon.aws.kms_key module – Perform various KMS key management tasks
Note
This module is part of the amazon.aws collection (version 7.6.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.
New in amazon.aws 5.0.0
Synopsis
Manage role/user access to a KMS key.
Not designed for encrypting/decrypting.
Prior to release 5.0.0 this module was called
community.aws.aws_kms. The usage did not change.This module was originally added to
community.awsin release 1.0.0.
Aliases: aws_kms
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 |
|
An alias for a key. For safety, even though KMS does not require keys to have an alias, this module expects all new keys to be given an alias to make them easier to manage. Existing keys without an alias may be referred to by key_id. Use amazon.aws.kms_key_info to find key ids. Note that passing a key_id and alias will only cause a new alias to be added, an alias will never be renamed. The Required if key_id is not given. |
|
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:
|
|
A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task. |
|
Whether the key should be automatically rotated every year. Choices:
|
|
Whether or not a key is enabled. 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 list of grants to apply to the key. Each item must contain grantee_principal. Each item can optionally contain retiring_principal, operations, constraints, name. grantee_principal and retiring_principal must be ARNs For full documentation of suboptions see the boto3 documentation: Default: |
|
Constraints is a dict containing |
|
The full ARN of the principal being granted permissions. |
|
A list of operations that the grantee may perform using the CMK. Choices:
|
|
The full ARN of the principal permitted to revoke/retire the grant. |
|
Key ID or ARN of the key. One of alias or key_id are required. |
|
Specifies the type of KMS key to create. The specification is not changeable once the key is created. Choices:
|
|
Determines the cryptographic operations for which you can use the KMS key. The usage is not changeable once the key is created. Choices:
|
|
Whether to create a multi-Region primary key or not. Choices:
|
|
The number of days between requesting deletion of the CMK and when it will actually be deleted. Only used when state=absent and the CMK has not yet been deleted. Valid values are between 7 and 30 (inclusive). |
|
policy to apply to the KMS key. See https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html |
|
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. |
|
Whether the grants argument should cause grants not in the list to be removed. Choices:
|
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
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 |
|
Whether a key should be present or absent. Note that making an existing key Passing a key that is scheduled for deletion with state=present will cancel key deletion. Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
There are known inconsistencies in the amount of time required for updates of KMS keys to be fully reflected on AWS. This can cause issues when running duplicate tasks in succession or using the amazon.aws.kms_key_info module to fetch key metadata shortly after modifying keys. For this reason, it is recommended to use the return data from this module (amazon.aws.kms_key) to fetch a key’s metadata.
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
# Create a new KMS key
- amazon.aws.kms_key:
alias: mykey
tags:
Name: myKey
Purpose: protect_stuff
# Create a new multi-region KMS key
- amazon.aws.kms_key:
alias: mykey
multi_region: true
tags:
Name: myKey
Purpose: protect_stuff
# Update previous key with more tags
- amazon.aws.kms_key:
alias: mykey
tags:
Name: myKey
Purpose: protect_stuff
Owner: security_team
# Update a known key with grants allowing an instance with the billing-prod IAM profile
# to decrypt data encrypted with the environment: production, application: billing
# encryption context
- amazon.aws.kms_key:
key_id: abcd1234-abcd-1234-5678-ef1234567890
grants:
- name: billing_prod
grantee_principal: arn:aws:iam::123456789012:role/billing_prod
constraints:
encryption_context_equals:
environment: production
application: billing
operations:
- Decrypt
- RetireGrant
- name: Update IAM policy on an existing KMS key
amazon.aws.kms_key:
alias: my-kms-key
policy: '{"Version": "2012-10-17", "Id": "my-kms-key-permissions", "Statement": [ { <SOME STATEMENT> } ]}'
state: present
- name: Example using lookup for policy json
amazon.aws.kms_key:
alias: my-kms-key
policy: "{{ lookup('template', 'kms_iam_policy_template.json.j2') }}"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of aliases associated with the key. Returned: always Sample: |
|
The AWS Account ID that the key belongs to. Returned: always Sample: |
|
Grant types that would be changed/were changed. Returned: always Sample: |
|
Date and time of creation of the key. Returned: always Sample: |
|
Date and time after which KMS deletes this KMS key. Returned: when key_state is PendingDeletion 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: |
|
Whether the key is enabled. True if key_state is 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: |
|
Whether there are invalid (non-ARN) entries in the KMS entry. These don’t count as a change, but will be removed if any changes are being made. Returned: always |
|
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. Will be one of Returned: always Sample: |
|
The cryptographic operations for which you can use the key. Returned: always Sample: |
|
Indicates whether the CMK is a multi-Region This value is True for multi-Region primary and replica CMKs and False for regional CMKs. 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: |