Group

Provides an IAM group.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var developers = new Aws.Iam.Group("developers", new Aws.Iam.GroupArgs
        {
            Path = "/users/",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := iam.NewGroup(ctx, "developers", &iam.GroupArgs{
            Path: pulumi.String("/users/"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

developers = aws.iam.Group("developers", path="/users/")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const developers = new aws.iam.Group("developers", {
    path: "/users/",
});

Create a Group Resource

new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);

def Group(resource_name: str, opts: Optional[ResourceOptions] = None, name: Optional[str] = None, path: Optional[str] = None)

func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Group resource accepts the following input properties:

Name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
Path string: Path in which to create the group.

Name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
Path string: Path in which to create the group.

name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
path string: Path in which to create the group.

name str: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
path str: Path in which to create the group.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Arn string: The ARN assigned by AWS for this group.
Id string: The provider-assigned unique ID for this managed resource.
UniqueId string: The [unique ID][1] assigned by AWS.

Arn string: The ARN assigned by AWS for this group.
Id string: The provider-assigned unique ID for this managed resource.
UniqueId string: The [unique ID][1] assigned by AWS.

arn string: The ARN assigned by AWS for this group.
id string: The provider-assigned unique ID for this managed resource.
uniqueId string: The [unique ID][1] assigned by AWS.

arn str: The ARN assigned by AWS for this group.
id str: The provider-assigned unique ID for this managed resource.
unique_id str: The [unique ID][1] assigned by AWS.

Look up an Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group

@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, arn: Optional[str] = None, name: Optional[str] = None, path: Optional[str] = None, unique_id: Optional[str] = None) -> Group

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN assigned by AWS for this group.
Name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
Path string: Path in which to create the group.
UniqueId string: The [unique ID][1] assigned by AWS.

Arn string: The ARN assigned by AWS for this group.
Name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
Path string: Path in which to create the group.
UniqueId string: The [unique ID][1] assigned by AWS.

arn string: The ARN assigned by AWS for this group.
name string: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
path string: Path in which to create the group.
uniqueId string: The [unique ID][1] assigned by AWS.

arn str: The ARN assigned by AWS for this group.
name str: The group’s name. The name must consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-_.. Group names are not distinguished by case. For example, you cannot create groups named both “ADMINS” and “admins”.
path str: Path in which to create the group.
unique_id str: The [unique ID][1] assigned by AWS.

Import

IAM Groups can be imported using the name, e.g.

 $ pulumi import aws:iam/group:Group developers developers

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud