community.aws.aws_kms module – Perform various KMS management tasks.
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.
New in community.aws 1.0.0
Synopsis
Manage role/user access to a KMS key. Not designed for encrypting/decrypting.
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 |
|---|---|
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 community.aws.aws_kms_info to find key ids. Required if key_id is not given. Note that passing a key_id and alias will only cause a new alias to be added, an alias will never be renamed. The ‘alias/’ prefix is optional. |
|
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:
|
|
A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task. |
|
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. |
|
Whether the key should be automatically rotated every year. Choices:
|
|
Whether or not a key is enabled Choices:
|
|
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: |
|
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:
|
|
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 |
|
(deprecated) If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases. Only cleans if changes are being made. Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console. This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead. Choices:
|
|
(deprecated) List of grants to give to user/role. Likely “role,role grant” or “role,role grant,admin”. Required when policy_mode=grant. Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console. This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead. |
|
(deprecated) Grant or deny access. Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console. This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead. Choices:
|
|
(deprecated) ARN of role to allow/deny access. One of policy_role_name or policy_role_arn are required. Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console. This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead. |
|
(deprecated) Role to allow/deny access. One of policy_role_name or policy_role_arn are required. Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console. This option has been deprecated, and will be removed in a release after 2021-12-01. Use policy instead. |
|
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. |
|
Whether the grants argument should cause grants not in the list to be removed Choices:
|
|
Whether the tags argument should cause tags not in the list to be removed Choices:
|
|
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. |
|
Whether a key should be present or absent. Note that making an existing key absent only schedules a key for deletion. Passing a key that is scheduled for deletion with state present will cancel key deletion. Choices:
|
|
A dictionary of tags to apply to a key. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. 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 aws_kms_info module to fetch key metadata shortly after modifying keys. For this reason, it is recommended to use the return data from this module (aws_kms) to fetch a key’s metadata.
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLEWhen 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_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Managing the KMS IAM Policy via policy_mode and policy_grant_types is fragile
# and has been deprecated in favour of the policy option.
- name: grant user-style access to production secrets
community.aws.aws_kms:
args:
alias: "alias/my_production_secrets"
policy_mode: grant
policy_role_name: "prod-appServerRole-1R5AQG2BSEL6L"
policy_grant_types: "role,role grant"
- name: remove access to production secrets from role
community.aws.aws_kms:
args:
alias: "alias/my_production_secrets"
policy_mode: deny
policy_role_name: "prod-appServerRole-1R5AQG2BSEL6L"
# Create a new KMS key
- community.aws.aws_kms:
alias: mykey
tags:
Name: myKey
Purpose: protect_stuff
# Update previous key with more tags
- community.aws.aws_kms:
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
- community.aws.aws_kms:
key_id: abcd1234-abcd-1234-5678-ef1234567890
grants:
- name: billing_prod
grantee_principal: arn:aws:iam::1234567890123:role/billing_prod
constraints:
encryption_context_equals:
environment: production
application: billing
operations:
- Decrypt
- RetireGrant
- name: Update IAM policy on an existing KMS key
community.aws.aws_kms:
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
community.aws.aws_kms:
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 of creation of the key Returned: always 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 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: |
|
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 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 Returned: always Sample: |