community / community.aws / 4.3.0 / module / iam_access_key Manage AWS IAM User access keys | "added in version" 2.1.0 of community.aws" Authors: Mark Chappell (@tremble)community.aws.iam_access_key (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Manage AWS IAM user access keys.
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Create a new access key community.aws.iam_access_key: user_name: example_user state: present
- name: Delete the access_key community.aws.iam_access_key: name: example_user access_key_id: AKIA1EXAMPLE1EXAMPLE state: absent
id: description: - The ID of the access key. - Required when I(state=absent). - Mutually exclusive with I(rotate_keys). required: false type: str state: choices: - present - absent default: present description: - Create or remove the access key. - When I(state=present) and I(id) is not defined a new key will be created. required: false type: str active: aliases: - enabled description: - Whether the key should be enabled or disabled. - Defaults to C(true) when creating a new key. required: false type: bool 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: aliases: - aws_endpoint_url - endpoint_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 profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str user_name: aliases: - username description: - The name of the IAM User to which the key belongs. required: true type: str 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 rotate_keys: default: false description: - When there are already 2 access keys attached to the IAM user the oldest key will be removed and a new key created. - Ignored if I(state=absent) - Mutually exclusive with I(id). required: false type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - 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. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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 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
access_key: contains: access_key_id: description: The ID for the access key. returned: success sample: AKIA1EXAMPLE1EXAMPLE type: str create_date: description: The date and time, in ISO 8601 date-time format, when the access key was created. returned: success sample: '2021-10-09T13:25:42+00:00' type: str status: description: - The status of the key. - C(Active) means it can be used. - C(Inactive) means it can not be used. returned: success sample: Inactive type: str user_name: description: The name of the IAM user to which the key is attached. returned: success sample: example_user type: str description: A dictionary containing all the access key information. returned: When the key exists. type: complex deleted_access_key_id: description: - The access key deleted during rotation. returned: When a key was deleted during the rotation of access keys sample: AKIA1EXAMPLE1EXAMPLE type: str secret_access_key: description: - The secret access key. - A secret access key is the equivalent of a password which can not be changed and as such should be considered sensitive data. - Secret access keys can only be accessed at creation time. returned: When a new key is created. sample: example/Example+EXAMPLE+example/Example type: str