ansible / ansible.builtin / v2.9.13 / module / iam_group Manage AWS IAM groups | "added in version" 2.4 of ansible.builtin" Authors: Nick Aslanidis (@naslanidis), Maksym Postument (@infectsoldier) preview | supported by communityansible.builtin.iam_group (v2.9.13) — module
pip
Install with pip install ansible==2.9.13
Manage AWS IAM groups
# Note: These examples do not set authentication details, see the AWS Guide for details. # Create a group - iam_group: name: testgroup1 state: present
# Create a group and attach a managed policy using its ARN - iam_group: name: testgroup1 managed_policy: - arn:aws:iam::aws:policy/AmazonSNSFullAccess state: present
# Create a group with users as members and attach a managed policy using its ARN - iam_group: name: testgroup1 managed_policy: - arn:aws:iam::aws:policy/AmazonSNSFullAccess users: - test_user1 - test_user2 state: present
# Remove all managed policies from an existing group with an empty list - iam_group: name: testgroup1 state: present purge_policy: true
# Remove all group members from an existing group - iam_group: name: testgroup1 managed_policy: - arn:aws:iam::aws:policy/AmazonSNSFullAccess purge_users: true state: present
# Delete the group - iam_group: name: testgroup1 state: absent
name: description: - The name of the group to create. required: true type: str state: choices: - present - absent description: - Create or remove the IAM group required: true type: str users: description: - A list of existing users to add as members of the group. required: false type: list region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str purge_users: default: false description: - Detach users which not included in users list required: false type: bool endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str purge_policy: default: false description: - Detach policy which not included in managed_policy list required: false type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str managed_policy: description: - A list of managed policy ARNs or friendly names to attach to the role. To embed an inline policy, use M(iam_policy). required: false type: list validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
group: contains: arn: description: the Amazon Resource Name (ARN) specifying the group sample: arn:aws:iam::1234567890:group/testgroup1 type: str create_date: description: the date and time, in ISO 8601 date-time format, when the group was created sample: '2017-02-08T04:36:28+00:00' type: str group_id: description: the stable and unique string identifying the group sample: AGPAIDBWE12NSFINE55TM type: str group_name: description: the friendly name that identifies the group sample: testgroup1 type: str path: description: the path to the group sample: / type: str description: dictionary containing all the group information returned: success type: complex users: contains: arn: description: the Amazon Resource Name (ARN) specifying the user sample: arn:aws:iam::1234567890:user/test_user1 type: str create_date: description: the date and time, in ISO 8601 date-time format, when the user was created sample: '2017-02-08T04:36:28+00:00' type: str path: description: the path to the user sample: / type: str user_id: description: the stable and unique string identifying the user sample: AIDAIZTPY123YQRS22YU2 type: str user_name: description: the friendly name that identifies the user sample: testgroup1 type: str description: list containing all the group members returned: success type: complex