New in version 2.3.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| aws_access_key | no | 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 | no | 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 | no | True |
| 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 | no | 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 | no | List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin". Required when mode=grant. | ||
| key_alias | no | Alias label to the key. One of key_alias or key_arn are required. | ||
| key_arn | no | Full ARN to the key. One of key_alias or key_arn are required. | ||
| mode | yes | grant |
| Grant or deny access. |
| profile (added in 1.6)
| no | Uses a boto profile. Only works with boto >= 2.24.0. | ||
| region | no | 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 | no | ARN of role to allow/deny access. One of role_name or role_arn are required. | ||
| role_name | no | Role to allow/deny access. One of role_name or role_arn are required. | ||
| security_token (added in 1.6)
| no | 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 (added in 1.5)
| no | yes |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
- name: grant user-style access to production secrets
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
kms:
args:
mode: deny
key_alias: "alias/my_production_secrets"
role_name: "prod-appServerRole-1R5AQG2BSEL6L"
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| had_invalid_entries | 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. | always | boolean | |
| changes_needed | grant types that would be changed/were changed. | always | dict | {'role grant': 'add', 'role': 'add'} |
Note
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
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 fileThis module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/aws_kms_module.html