GroupArgs

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

Creates a Group. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun GroupArgs(description: Output<String>? = null, displayName: Output<String>? = null, dynamicGroupMetadata: Output<DynamicGroupMetadataArgs>? = null, groupKey: Output<EntityKeyArgs>? = null, initialGroupConfig: Output<String>? = null, labels: Output<Map<String, String>>? = null, parent: Output<String>? = null)

Functions

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

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

Optional. Dynamic group metadata like queries and status.

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

The EntityKey of the Group.

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

Optional. The initial configuration option for the Group.

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

Immutable. 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} for external identity-mapped groups or customers/{customer_id} for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn'). Find your customer ID. (https://support.google.com/cloudidentity/answer/10070793)