ansible / ansible.builtin / v2.7.18 / module / aws_kms Perform various KMS management tasks. | "added in version" 2.3 of ansible.builtin" Authors: Ted Timmons (@tedder) preview | supported by certifiedansible.builtin.aws_kms (v2.7.18) — module
pip
Install with pip install ansible==2.7.18
Manage role/user access to a KMS key. Not designed for encrypting/decrypting.
- 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"
mode: choices: - grant - deny default: grant description: - Grant or deny access. required: true region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: description: - 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. type: str key_arn: description: - Full ARN to the key. One of C(key_alias) or C(key_arn) are required. required: false profile: description: - Uses a boto profile. Only works with boto >= 2.24.0. type: str role_arn: description: - ARN of role to allow/deny access. One of C(role_name) or C(role_arn) are required. required: false key_alias: description: - Alias label to the key. One of C(key_alias) or C(key_arn) are required. required: false role_name: description: - Role to allow/deny access. One of C(role_name) or C(role_arn) are required. required: false aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict grant_types: description: - List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin". Required when C(mode=grant). required: false aws_access_key: aliases: - ec2_access_key - access_key description: - 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. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - 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. type: str security_token: aliases: - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool clean_invalid_entries: default: true description: - 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. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
changes_needed: description: grant types that would be changed/were changed. returned: always sample: role: add role grant: add type: dict had_invalid_entries: description: 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 type: boolean