group#

State module for managing IAM Groups.

async idem_aws.states.aws.iam.group.present(hub, ctx, name: str, group_name: str, resource_id: str = None, path: str = None) → Dict[str, Any][source]#

Create/Update the IAM Group.

Creates a new group. For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.

Parameters:

  • name (str) – An Idem name of the resource. This is also used as the name of the IAM group.

  • resource_id (str, Optional) – An identifier of the resource in the provider. Name of Group.

  • path (str, Optional) – The path to the group. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. For more information about paths, see IAM identifiers in the IAM User Guide.

  • group_name (str) – The name of the group to create. Do not include the path in this value. IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

Request Syntax:
[group_name]:
  aws.iam.group.present:
    - name: "string"
    - group_name: "string"
    - resource_id: "string"
    - path: "string"
Returns:

Dict[str, Any]

Examples

test-group:
  aws.iam.group.present:
    - name: test-group
    - resource_id: test-group
    - group_name: test-group
    - path: /
async idem_aws.states.aws.iam.group.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the specified IAM group.

The group must not contain any users or have any attached policies.

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – Name of IAM group.

Request Syntax:
[group_name]:
  aws.iam.group.absent:
    - name: "string"
    - resource_id: "string"
Returns:

Dict[str, Any]

Examples

test-group:
  aws.iam.group.absent:
    - name: test-group
    - resource_id: test-group
async idem_aws.states.aws.iam.group.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Gets information about the IAM Group.

Describe the resource in a way that can be recreated/managed with the corresponding present function.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.iam.group