Group

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auto_devops_enabled: Optional[bool] = None,
          description: Optional[str] = None,
          emails_disabled: Optional[bool] = None,
          lfs_enabled: Optional[bool] = None,
          mentions_disabled: Optional[bool] = None,
          name: Optional[str] = None,
          parent_id: Optional[int] = None,
          path: Optional[str] = None,
          project_creation_level: Optional[str] = None,
          request_access_enabled: Optional[bool] = None,
          require_two_factor_authentication: Optional[bool] = None,
          share_with_group_lock: Optional[bool] = None,
          subgroup_creation_level: Optional[str] = None,
          two_factor_grace_period: Optional[int] = None,
          visibility_level: Optional[str] = None)
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = 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.
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.

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:

Path string
The path of the group.
AutoDevopsEnabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
Description string
The description of the group.
EmailsDisabled bool
Boolean, defaults to false. Disable email notifications
LfsEnabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
MentionsDisabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
Name string
The name of this group.
ParentId int
Integer, id of the parent group (creates a nested group).
ProjectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
RequestAccessEnabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
RequireTwoFactorAuthentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
ShareWithGroupLock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
SubgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
TwoFactorGracePeriod int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group’s visibility. Can be private, internal, or public.
Path string
The path of the group.
AutoDevopsEnabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
Description string
The description of the group.
EmailsDisabled bool
Boolean, defaults to false. Disable email notifications
LfsEnabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
MentionsDisabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
Name string
The name of this group.
ParentId int
Integer, id of the parent group (creates a nested group).
ProjectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
RequestAccessEnabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
RequireTwoFactorAuthentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
ShareWithGroupLock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
SubgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
TwoFactorGracePeriod int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group’s visibility. Can be private, internal, or public.
path string
The path of the group.
autoDevopsEnabled boolean
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
description string
The description of the group.
emailsDisabled boolean
Boolean, defaults to false. Disable email notifications
lfsEnabled boolean
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
mentionsDisabled boolean
Boolean, defaults to false. Disable the capability of a group from getting mentioned
name string
The name of this group.
parentId number
Integer, id of the parent group (creates a nested group).
projectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
requestAccessEnabled boolean
Boolean, defaults to false. Whether to enable users to request access to the group.
requireTwoFactorAuthentication boolean
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
shareWithGroupLock boolean
Boolean, defaults to false. Prevent sharing a project with another group within this group.
subgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
twoFactorGracePeriod number
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel string
The group’s visibility. Can be private, internal, or public.
path str
The path of the group.
auto_devops_enabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
description str
The description of the group.
emails_disabled bool
Boolean, defaults to false. Disable email notifications
lfs_enabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
mentions_disabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
name str
The name of this group.
parent_id int
Integer, id of the parent group (creates a nested group).
project_creation_level str
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
request_access_enabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
require_two_factor_authentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
share_with_group_lock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
subgroup_creation_level str
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
two_factor_grace_period int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibility_level str
The group’s visibility. Can be private, internal, or public.

Outputs

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

FullName string
The full name of the group.
FullPath string
The full path of the group.
Id string
The provider-assigned unique ID for this managed resource.
RunnersToken string
The group level registration token to use during runner setup.
WebUrl string
Web URL of the group.
FullName string
The full name of the group.
FullPath string
The full path of the group.
Id string
The provider-assigned unique ID for this managed resource.
RunnersToken string
The group level registration token to use during runner setup.
WebUrl string
Web URL of the group.
fullName string
The full name of the group.
fullPath string
The full path of the group.
id string
The provider-assigned unique ID for this managed resource.
runnersToken string
The group level registration token to use during runner setup.
webUrl string
Web URL of the group.
full_name str
The full name of the group.
full_path str
The full path of the group.
id str
The provider-assigned unique ID for this managed resource.
runners_token str
The group level registration token to use during runner setup.
web_url str
Web URL of the group.

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_devops_enabled: Optional[bool] = None,
        description: Optional[str] = None,
        emails_disabled: Optional[bool] = None,
        full_name: Optional[str] = None,
        full_path: Optional[str] = None,
        lfs_enabled: Optional[bool] = None,
        mentions_disabled: Optional[bool] = None,
        name: Optional[str] = None,
        parent_id: Optional[int] = None,
        path: Optional[str] = None,
        project_creation_level: Optional[str] = None,
        request_access_enabled: Optional[bool] = None,
        require_two_factor_authentication: Optional[bool] = None,
        runners_token: Optional[str] = None,
        share_with_group_lock: Optional[bool] = None,
        subgroup_creation_level: Optional[str] = None,
        two_factor_grace_period: Optional[int] = None,
        visibility_level: Optional[str] = None,
        web_url: Optional[str] = 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)
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:

AutoDevopsEnabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
Description string
The description of the group.
EmailsDisabled bool
Boolean, defaults to false. Disable email notifications
FullName string
The full name of the group.
FullPath string
The full path of the group.
LfsEnabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
MentionsDisabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
Name string
The name of this group.
ParentId int
Integer, id of the parent group (creates a nested group).
Path string
The path of the group.
ProjectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
RequestAccessEnabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
RequireTwoFactorAuthentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
RunnersToken string
The group level registration token to use during runner setup.
ShareWithGroupLock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
SubgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
TwoFactorGracePeriod int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group’s visibility. Can be private, internal, or public.
WebUrl string
Web URL of the group.
AutoDevopsEnabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
Description string
The description of the group.
EmailsDisabled bool
Boolean, defaults to false. Disable email notifications
FullName string
The full name of the group.
FullPath string
The full path of the group.
LfsEnabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
MentionsDisabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
Name string
The name of this group.
ParentId int
Integer, id of the parent group (creates a nested group).
Path string
The path of the group.
ProjectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
RequestAccessEnabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
RequireTwoFactorAuthentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
RunnersToken string
The group level registration token to use during runner setup.
ShareWithGroupLock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
SubgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
TwoFactorGracePeriod int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
VisibilityLevel string
The group’s visibility. Can be private, internal, or public.
WebUrl string
Web URL of the group.
autoDevopsEnabled boolean
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
description string
The description of the group.
emailsDisabled boolean
Boolean, defaults to false. Disable email notifications
fullName string
The full name of the group.
fullPath string
The full path of the group.
lfsEnabled boolean
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
mentionsDisabled boolean
Boolean, defaults to false. Disable the capability of a group from getting mentioned
name string
The name of this group.
parentId number
Integer, id of the parent group (creates a nested group).
path string
The path of the group.
projectCreationLevel string
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
requestAccessEnabled boolean
Boolean, defaults to false. Whether to enable users to request access to the group.
requireTwoFactorAuthentication boolean
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
runnersToken string
The group level registration token to use during runner setup.
shareWithGroupLock boolean
Boolean, defaults to false. Prevent sharing a project with another group within this group.
subgroupCreationLevel string
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
twoFactorGracePeriod number
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibilityLevel string
The group’s visibility. Can be private, internal, or public.
webUrl string
Web URL of the group.
auto_devops_enabled bool
Boolean, defaults to false. Default to Auto DevOps pipeline for all projects within this group.
description str
The description of the group.
emails_disabled bool
Boolean, defaults to false. Disable email notifications
full_name str
The full name of the group.
full_path str
The full path of the group.
lfs_enabled bool
Boolean, defaults to true. Whether to enable LFS support for projects in this group.
mentions_disabled bool
Boolean, defaults to false. Disable the capability of a group from getting mentioned
name str
The name of this group.
parent_id int
Integer, id of the parent group (creates a nested group).
path str
The path of the group.
project_creation_level str
, defaults to Maintainer. Determine if developers can create projects in the group. Can be noone (No one), maintainer (Maintainers), or developer (Developers + Maintainers).
request_access_enabled bool
Boolean, defaults to false. Whether to enable users to request access to the group.
require_two_factor_authentication bool
Boolean, defaults to false. equire all users in this group to setup Two-factor authentication.
runners_token str
The group level registration token to use during runner setup.
share_with_group_lock bool
Boolean, defaults to false. Prevent sharing a project with another group within this group.
subgroup_creation_level str
, defaults to Owner. Allowed to create subgroups. Can be owner (Owners), or maintainer (Maintainers).
two_factor_grace_period int
Int, defaults to 48. Time before Two-factor authentication is enforced (in hours).
visibility_level str
The group’s visibility. Can be private, internal, or public.
web_url str
Web URL of the group.

Package Details

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