Group
Create a Group Resource
new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);def Group(resource_name, opts=None, description=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, visibility_level=None, __props__=None);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:
- Path string
The path of the group.
- Description string
The description of the group.
- Lfs
Enabled bool Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, id of the parent group (creates a nested group).
- Request
Access boolEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- Visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.
- Path string
The path of the group.
- Description string
The description of the group.
- Lfs
Enabled bool Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, id of the parent group (creates a nested group).
- Request
Access boolEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- Visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.
- path string
The path of the group.
- description string
The description of the group.
- lfs
Enabled boolean Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- name string
The name of this group.
- parent
Id number Integer, id of the parent group (creates a nested group).
- request
Access booleanEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.
- path str
The path of the group.
- description str
The description of the group.
- lfs_
enabled bool Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- name str
The name of this group.
- parent_
id float Integer, id of the parent group (creates a nested group).
- request_
access_ boolenabled Boolean, defaults to false. Whether to enable users to request access to the group.
- visibility_
level str Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.
Outputs
All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:
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): Groupstatic get(resource_name, id, opts=None, description=None, full_name=None, full_path=None, lfs_enabled=None, name=None, parent_id=None, path=None, request_access_enabled=None, runners_token=None, visibility_level=None, web_url=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:
- Description string
The description of the group.
- Full
Name string The full name of the group.
- Full
Path string The full path of the group.
- Lfs
Enabled bool Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, id of the parent group (creates a nested group).
- Path string
The path of the group.
- Request
Access boolEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- Runners
Token string The group level registration token to use during runner setup.
- Visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.- Web
Url string Web URL of the group.
- Description string
The description of the group.
- Full
Name string The full name of the group.
- Full
Path string The full path of the group.
- Lfs
Enabled bool Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- Name string
The name of this group.
- Parent
Id int Integer, id of the parent group (creates a nested group).
- Path string
The path of the group.
- Request
Access boolEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- Runners
Token string The group level registration token to use during runner setup.
- Visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.- Web
Url string Web URL of the group.
- description string
The description of the group.
- full
Name string The full name of the group.
- full
Path string The full path of the group.
- lfs
Enabled boolean Boolean, defaults to true. Whether to enable LFS support for projects in this group.
- name string
The name of this group.
- parent
Id number Integer, id of the parent group (creates a nested group).
- path string
The path of the group.
- request
Access booleanEnabled Boolean, defaults to false. Whether to enable users to request access to the group.
- runners
Token string The group level registration token to use during runner setup.
- visibility
Level string Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.- web
Url string Web URL of the group.
- description str
The description of the group.
- 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.
- name str
The name of this group.
- parent_
id float Integer, id of the parent group (creates a nested group).
- path str
The path of the group.
- request_
access_ boolenabled Boolean, defaults to false. Whether to enable users to request access to the group.
- runners_
token str The group level registration token to use during runner setup.
- visibility_
level str Set to
publicto create a public group. Valid values areprivate,internal,public. Groups are created as private by default.- 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
gitlabTerraform Provider.