Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. Group
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.Group

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    Group resource manages Google Workspace Groups. Group resides under the https://www.googleapis.com/auth/admin.directory.group client scope.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.Group;
import com.pulumi.googleworkspace.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sales = new Group("sales", GroupArgs.builder()
            .email("sales@example.com")
            .description("Sales Group")
            .aliases(            
                "paper-sales@example.com",
                "sales-dept@example.com")
            .timeouts(GroupTimeoutsArgs.builder()
                .create("1m")
                .update("1m")
                .build())
            .build());

    }
}

    resources:
  sales:
    type: googleworkspace:Group
    properties:
      email: sales@example.com
      description: Sales Group
      aliases:
        - paper-sales@example.com
        - sales-dept@example.com
      timeouts:
        - create: 1m
          update: 1m

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          email: Optional[str] = None,
          aliases: Optional[Sequence[str]] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          timeouts: Optional[GroupTimeoutsArgs] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: googleworkspace:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var groupResource = new Googleworkspace.Group("groupResource", new()
{
    Email = "string",
    Aliases = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    Timeouts = new Googleworkspace.Inputs.GroupTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := googleworkspace.NewGroup(ctx, "groupResource", &googleworkspace.GroupArgs{
Email: pulumi.String("string"),
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Timeouts: &.GroupTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .email("string")
    .aliases("string")
    .description("string")
    .name("string")
    .timeouts(GroupTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    group_resource = googleworkspace.Group("groupResource",
    email="string",
    aliases=["string"],
    description="string",
    name="string",
    timeouts={
        "create": "string",
        "update": "string",
    })

    const groupResource = new googleworkspace.Group("groupResource", {
    email: "string",
    aliases: ["string"],
    description: "string",
    name: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: googleworkspace:Group
properties:
    aliases:
        - string
    description: string
    email: string
    name: string
    timeouts:
        create: string
        update: string

    Group Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Group resource accepts the following input properties:

    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Aliases List<string>
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    Name string
    The group's display name.
    Timeouts GroupTimeouts
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Aliases []string
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    Name string
    The group's display name.
    Timeouts GroupTimeoutsArgs
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    name String
    The group's display name.
    timeouts GroupTimeouts
    email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    aliases string[]
    asps.list of group's email addresses.
    description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    name string
    The group's display name.
    timeouts GroupTimeouts
    email str
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    aliases Sequence[str]
    asps.list of group's email addresses.
    description str
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    name str
    The group's display name.
    timeouts GroupTimeoutsArgs
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    name String
    The group's display name.
    timeouts Property Map

    Outputs

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

    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    DirectMembersCount double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NonEditableAliases List<string>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    DirectMembersCount float64
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NonEditableAliases []string
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    directMembersCount Double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated boolean
    Value is true if this group was created by an administrator rather than a user.
    directMembersCount number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    nonEditableAliases string[]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    admin_created bool
    Value is true if this group was created by an administrator rather than a user.
    direct_members_count float
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    non_editable_aliases Sequence[str]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    directMembersCount Number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.

    Look up 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,
        admin_created: Optional[bool] = None,
        aliases: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        direct_members_count: Optional[float] = None,
        email: Optional[str] = None,
        etag: Optional[str] = None,
        name: Optional[str] = None,
        non_editable_aliases: Optional[Sequence[str]] = None,
        timeouts: Optional[GroupTimeoutsArgs] = 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)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: googleworkspace:Group    get:      id: ${id}
    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.
    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:
    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    Aliases List<string>
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    DirectMembersCount double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Etag string
    ETag of the resource.
    Name string
    The group's display name.
    NonEditableAliases List<string>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    Timeouts GroupTimeouts
    AdminCreated bool
    Value is true if this group was created by an administrator rather than a user.
    Aliases []string
    asps.list of group's email addresses.
    Description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    DirectMembersCount float64
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    Email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    Etag string
    ETag of the resource.
    Name string
    The group's display name.
    NonEditableAliases []string
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    Timeouts GroupTimeoutsArgs
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount Double
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag String
    ETag of the resource.
    name String
    The group's display name.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    timeouts GroupTimeouts
    adminCreated boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases string[]
    asps.list of group's email addresses.
    description string
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email string
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag string
    ETag of the resource.
    name string
    The group's display name.
    nonEditableAliases string[]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    timeouts GroupTimeouts
    admin_created bool
    Value is true if this group was created by an administrator rather than a user.
    aliases Sequence[str]
    asps.list of group's email addresses.
    description str
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    direct_members_count float
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email str
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag str
    ETag of the resource.
    name str
    The group's display name.
    non_editable_aliases Sequence[str]
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    timeouts GroupTimeoutsArgs
    adminCreated Boolean
    Value is true if this group was created by an administrator rather than a user.
    aliases List<String>
    asps.list of group's email addresses.
    description String
    An extended description to help users determine the purpose of a group.For example, you can include information about who should join the group,the types of messages to send to the group, links to FAQs about the group, or related groups.
    directMembersCount Number
    The number of users that are direct members of the group.If a group is a member (child) of this group (the parent),members of the child group are not counted in the directMembersCount property of the parent group.
    email String
    The group's email address. If your account has multiple domains,select the appropriate domain for the email address. The email must be unique.
    etag String
    ETag of the resource.
    name String
    The group's display name.
    nonEditableAliases List<String>
    asps.list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group.
    timeouts Property Map

    Supporting Types

    GroupTimeouts, GroupTimeoutsArgs

    Create string
    Update string
    Create string
    Update string
    create String
    update String
    create string
    update string
    create str
    update str
    create String
    update String

    Import

    $ pulumi import googleworkspace:index/group:Group sales 01abcde23fg4h5i

    or with email as id

    $ pulumi import googleworkspace:index/group:Group sales sales@example.com

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
    hashicorp/terraform-provider-googleworkspace