Group

Create a Group Resource

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

def Group(resource_name, opts=None, description=None, display_name=None, group_key=None, labels=None, parent=None, __props__=None);

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

public Group(string name, GroupArgs args, 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:

GroupKey GroupGroupKeyArgs: EntityKey of the Group. Structure is documented below.
Labels Dictionary<string, string>: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
Parent string: 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.
Description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string: The display name of the Group.

GroupKey GroupGroupKey: EntityKey of the Group. Structure is documented below.
Labels map[string]string: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
Parent string: 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.
Description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string: The display name of the Group.

groupKey GroupGroupKey: EntityKey of the Group. Structure is documented below.
labels {[key: string]: string}: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
parent string: 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.
description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName string: The display name of the Group.

group_key Dict[GroupGroupKey]: EntityKey of the Group. Structure is documented below.
labels Dict[str, str]: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
parent str: 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.
description str: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
display_name str: The display name of the Group.

Outputs

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

CreateTime string: The time when the Group was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
UpdateTime string: The time when the Group was last updated.

CreateTime string: The time when the Group was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
UpdateTime string: The time when the Group was last updated.

createTime string: The time when the Group was created.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
updateTime string: The time when the Group was last updated.

create_time str: The time when the Group was created.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
update_time str: The time when the Group was last updated.

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

static get(resource_name, id, opts=None, create_time=None, description=None, display_name=None, group_key=None, labels=None, name=None, parent=None, update_time=None, __props__=None);

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:

CreateTime string: The time when the Group was created.
Description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string: The display name of the Group.
GroupKey GroupGroupKeyArgs: EntityKey of the Group. Structure is documented below.
Labels Dictionary<string, string>: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
Name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
Parent string: 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.
UpdateTime string: The time when the Group was last updated.

CreateTime string: The time when the Group was created.
Description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string: The display name of the Group.
GroupKey GroupGroupKey: EntityKey of the Group. Structure is documented below.
Labels map[string]string: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
Name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
Parent string: 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.
UpdateTime string: The time when the Group was last updated.

createTime string: The time when the Group was created.
description string: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName string: The display name of the Group.
groupKey GroupGroupKey: EntityKey of the Group. Structure is documented below.
labels {[key: string]: string}: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
name string: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent string: 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.
updateTime string: The time when the Group was last updated.

create_time str: The time when the Group was created.
description str: An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
display_name str: The display name of the Group.
group_key Dict[GroupGroupKey]: EntityKey of the Group. Structure is documented below.
labels Dict[str, str]: The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: “ if the Group is a Google Group or ‘system/groups/external’: “ if the Group is an external-identity-mapped group.
name str: Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent str: 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.
update_time str: The time when the Group was last updated.

Supporting Types

GroupGroupKey

See the input and output API doc for this type.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id str: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace str: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud