pulumi-gcp-kotlin/com.pulumi.gcp.cloudidentity.kotlin/GroupArgs

GroupArgs

data class GroupArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val groupKey: Output<GroupGroupKeyArgs>? = null, val initialGroupConfig: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val parent: Output<String>? = null) : ConvertibleToJava<GroupArgs>

A Cloud Identity resource representing a Group. To get more information about Group, see:

API documentation
How-to Guides

Official Documentation

Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billing_project and set user_project_override to true in the provider configuration. Otherwise the Cloud Identity API will return a 403 error. Your account must have the serviceusage.services.use permission on the billing_project you defined.

Example Usage

Cloud Identity Groups Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const cloudIdentityGroupBasic = new gcp.cloudidentity.Group("cloud_identity_group_basic", {
    displayName: "my-identity-group",
    initialGroupConfig: "WITH_INITIAL_OWNER",
    parent: "customers/A01b123xz",
    groupKey: {
        id: "my-identity-group@example.com",
    },
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
});

import pulumi
import pulumi_gcp as gcp
cloud_identity_group_basic = gcp.cloudidentity.Group("cloud_identity_group_basic",
    display_name="my-identity-group",
    initial_group_config="WITH_INITIAL_OWNER",
    parent="customers/A01b123xz",
    group_key={
        "id": "my-identity-group@example.com",
    },
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var cloudIdentityGroupBasic = new Gcp.CloudIdentity.Group("cloud_identity_group_basic", new()
    {
        DisplayName = "my-identity-group",
        InitialGroupConfig = "WITH_INITIAL_OWNER",
        Parent = "customers/A01b123xz",
        GroupKey = new Gcp.CloudIdentity.Inputs.GroupGroupKeyArgs
        {
            Id = "my-identity-group@example.com",
        },
        Labels =
        {
            { "cloudidentity.googleapis.com/groups.discussion_forum", "" },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/cloudidentity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudidentity.NewGroup(ctx, "cloud_identity_group_basic", &cloudidentity.GroupArgs{
			DisplayName:        pulumi.String("my-identity-group"),
			InitialGroupConfig: pulumi.String("WITH_INITIAL_OWNER"),
			Parent:             pulumi.String("customers/A01b123xz"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("my-identity-group@example.com"),
			},
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudidentity.Group;
import com.pulumi.gcp.cloudidentity.GroupArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupGroupKeyArgs;
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 cloudIdentityGroupBasic = new Group("cloudIdentityGroupBasic", GroupArgs.builder()
            .displayName("my-identity-group")
            .initialGroupConfig("WITH_INITIAL_OWNER")
            .parent("customers/A01b123xz")
            .groupKey(GroupGroupKeyArgs.builder()
                .id("my-identity-group@example.com")
                .build())
            .labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
            .build());
    }
}

resources:
  cloudIdentityGroupBasic:
    type: gcp:cloudidentity:Group
    name: cloud_identity_group_basic
    properties:
      displayName: my-identity-group
      initialGroupConfig: WITH_INITIAL_OWNER
      parent: customers/A01b123xz
      groupKey:
        id: my-identity-group@example.com
      labels:
        cloudidentity.googleapis.com/groups.discussion_forum:

Import

Group can be imported using any of these accepted formats:

{{name}} When using the pulumi import command, Group can be imported using one of the formats above. For example:

$ pulumi import gcp:cloudidentity/group:Group default {{name}}

Constructors

GroupArgs

constructor(description: Output<String>? = null, displayName: Output<String>? = null, groupKey: Output<GroupGroupKeyArgs>? = null, initialGroupConfig: Output<String>? = null, labels: Output<Map<String, String>>? = null, parent: Output<String>? = null)

Properties

description

val description: Output<String>? = null

An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.

displayName

val displayName: Output<String>? = null

The display name of the Group.

groupKey

val groupKey: Output<GroupGroupKeyArgs>? = null

EntityKey of the Group. Structure is documented below.

initialGroupConfig

val initialGroupConfig: Output<String>? = null

The initial configuration options for creating a Group. See the [API

labels

val labels: Output<Map<String, String>>? = null

One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.

parent

val parent: Output<String>? = null

The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.

Functions

toJava

open override fun toJava(): GroupArgs