Skip to main content

groups

Used to retrieve a list of groups in a region or create a groups resource, use group to operate on an individual resource.

Overview

Namegroups
TypeResource
DescriptionCreates a new group.<br/> For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Idaws.iam.groups

Fields

NameDatatypeDescription
group_namestringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<br/> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.<br/> If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).<br/> Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion

SELECT Example

SELECT
region,
group_name
FROM aws.iam.groups

Permissions

To operate on the groups resource, the following permissions are required:

Create

iam:CreateGroup,
iam:PutGroupPolicy,
iam:AttachGroupPolicy,
iam:GetGroupPolicy,
iam:GetGroup

List

iam:ListGroups