aws_kms – Perform various KMS management tasks.

New in version 2.3.

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.

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
-
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
-
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
clean_invalid_entries
boolean
    Choices:
  • no
  • yes ←
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.
ec2_url
-
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.
grant_types
-
List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin". Required when mode=grant.
key_alias
-
Alias label to the key. One of key_alias or key_arn are required.
key_arn
-
Full ARN to the key. One of key_alias or key_arn are required.
mode
- / required
    Choices:
  • grant ←
  • deny
Grant or deny access.
profile
-
added in 1.6
Uses a boto profile. Only works with boto >= 2.24.0.
region
-
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

aliases: aws_region, ec2_region
role_arn
-
ARN of role to allow/deny access. One of role_name or role_arn are required.
role_name
-
Role to allow/deny access. One of role_name or role_arn are required.
security_token
-
added in 1.6
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
validate_certs
boolean
added in 1.5
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: grant user-style access to production secrets
  aws_kms:
  args:
    mode: grant
    key_alias: "alias/my_production_secrets"
    role_name: "prod-appServerRole-1R5AQG2BSEL6L"
    grant_types: "role,role grant"
- name: remove access to production secrets from role
  aws_kms:
  args:
    mode: deny
    key_alias: "alias/my_production_secrets"
    role_name: "prod-appServerRole-1R5AQG2BSEL6L"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changes_needed
dictionary
 always
grant types that would be changed/were changed.

Sample:
{'role': 'add', 'role grant': 'add'}
had_invalid_entries
boolean
 always
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.


Status

Authors

  • Ted Timmons (@tedder)

Hint

If you notice any issues in this documentation you can edit this document to improve it.