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:

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

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")
.groupKey(GroupGroupKeyArgs.builder()
.id("my-identity-group@example.com")
.build())
.initialGroupConfig("WITH_INITIAL_OWNER")
.labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
.parent("customers/A01b123xz")
.build());
}
}

Import

Group can be imported using any of these accepted formats:

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

Constructors

Link copied to clipboard
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

Link copied to clipboard
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.

Link copied to clipboard
val displayName: Output<String>? = null

The display name of the Group.

Link copied to clipboard
val groupKey: Output<GroupGroupKeyArgs>? = null

EntityKey of the Group. Structure is documented below.

Link copied to clipboard
val initialGroupConfig: Output<String>? = null

The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are: INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, EMPTY.

Link copied to clipboard
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.

Link copied to clipboard
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

Link copied to clipboard
open override fun toJava(): GroupArgs