Skip to content

Latest commit

 

History

History
3440 lines (2176 loc) · 144 KB

group.python.md

File metadata and controls

3440 lines (2176 loc) · 144 KB
Raw

group Submodule

Constructs

Group

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group gitlab_group}.

Initializers 

from cdktf_cdktf_provider_gitlab import group

group.Group(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  path: str,
  auto_devops_enabled: typing.Union[bool, IResolvable] = None,
  avatar: str = None,
  avatar_hash: str = None,
  default_branch_protection: typing.Union[int, float] = None,
  description: str = None,
  emails_disabled: typing.Union[bool, IResolvable] = None,
  emails_enabled: typing.Union[bool, IResolvable] = None,
  extra_shared_runners_minutes_limit: typing.Union[int, float] = None,
  id: str = None,
  ip_restriction_ranges: typing.List[str] = None,
  lfs_enabled: typing.Union[bool, IResolvable] = None,
  membership_lock: typing.Union[bool, IResolvable] = None,
  mentions_disabled: typing.Union[bool, IResolvable] = None,
  parent_id: typing.Union[int, float] = None,
  prevent_forking_outside_group: typing.Union[bool, IResolvable] = None,
  project_creation_level: str = None,
  push_rules: GroupPushRules = None,
  request_access_enabled: typing.Union[bool, IResolvable] = None,
  require_two_factor_authentication: typing.Union[bool, IResolvable] = None,
  shared_runners_minutes_limit: typing.Union[int, float] = None,
  shared_runners_setting: str = None,
  share_with_group_lock: typing.Union[bool, IResolvable] = None,
  subgroup_creation_level: str = None,
  two_factor_grace_period: typing.Union[int, float] = None,
  visibility_level: str = None,
  wiki_access_level: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the group.
path str The path of the group.
auto_devops_enabled typing.Union[bool, cdktf.IResolvable] Default to Auto DevOps pipeline for all projects within this group.
avatar str A local path to the avatar image to upload. Note: not available for imported resources.
avatar_hash str The hash of the avatar image.
default_branch_protection typing.Union[int, float] See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection. Valid values are: 0, 1, 2, 3, 4.
description str The group's description.
emails_disabled typing.Union[bool, cdktf.IResolvable] Disable email notifications.
emails_enabled typing.Union[bool, cdktf.IResolvable] Enable email notifications.
extra_shared_runners_minutes_limit typing.Union[int, float] Can be set by administrators only. Additional CI/CD minutes for this group.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#id Group#id}.
ip_restriction_ranges typing.List[str] A list of IP addresses or subnet masks to restrict group access.
lfs_enabled typing.Union[bool, cdktf.IResolvable] Enable/disable Large File Storage (LFS) for the projects in this group.
membership_lock typing.Union[bool, cdktf.IResolvable] Users cannot be added to projects in this group.
mentions_disabled typing.Union[bool, cdktf.IResolvable] Disable the capability of a group from getting mentioned.
parent_id typing.Union[int, float] Id of the parent group (creates a nested group).
prevent_forking_outside_group typing.Union[bool, cdktf.IResolvable] Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
project_creation_level str Determine if developers can create projects in the group. Valid values are: noone, maintainer, developer.
push_rules GroupPushRules push_rules block.
request_access_enabled typing.Union[bool, cdktf.IResolvable] Allow users to request member access.
require_two_factor_authentication typing.Union[bool, cdktf.IResolvable] Require all users in this group to setup Two-factor authentication.
shared_runners_minutes_limit typing.Union[int, float] Can be set by administrators only.
shared_runners_setting str Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
share_with_group_lock typing.Union[bool, cdktf.IResolvable] Prevent sharing a project with another group within this group.
subgroup_creation_level str Allowed to create subgroups. Valid values are: owner, maintainer.
two_factor_grace_period typing.Union[int, float] 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. Valid values are: private, internal, public.
wiki_access_level str The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired
  • Type: str

The name of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#name Group#name}

pathRequired
  • Type: str

The path of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#path Group#path}

auto_devops_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Default to Auto DevOps pipeline for all projects within this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#auto_devops_enabled Group#auto_devops_enabled}

avatarOptional
  • Type: str

A local path to the avatar image to upload. Note: not available for imported resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#avatar Group#avatar}

avatar_hashOptional
  • Type: str

The hash of the avatar image.

Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#avatar_hash Group#avatar_hash}

default_branch_protectionOptional
  • Type: typing.Union[int, float]

See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection. Valid values are: 0, 1, 2, 3, 4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#default_branch_protection Group#default_branch_protection}

descriptionOptional
  • Type: str

The group's description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#description Group#description}

emails_disabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Disable email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#emails_disabled Group#emails_disabled}

emails_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#emails_enabled Group#emails_enabled}

extra_shared_runners_minutes_limitOptional
  • Type: typing.Union[int, float]

Can be set by administrators only. Additional CI/CD minutes for this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#extra_shared_runners_minutes_limit Group#extra_shared_runners_minutes_limit}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#id Group#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ip_restriction_rangesOptional
  • Type: typing.List[str]

A list of IP addresses or subnet masks to restrict group access.

Will be concatenated together into a comma separated string. Only allowed on top level groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#ip_restriction_ranges Group#ip_restriction_ranges}

lfs_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable/disable Large File Storage (LFS) for the projects in this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#lfs_enabled Group#lfs_enabled}

membership_lockOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Users cannot be added to projects in this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#membership_lock Group#membership_lock}

mentions_disabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Disable the capability of a group from getting mentioned.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#mentions_disabled Group#mentions_disabled}

parent_idOptional
  • Type: typing.Union[int, float]

Id of the parent group (creates a nested group).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#parent_id Group#parent_id}

prevent_forking_outside_groupOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Defaults to false. When enabled, users can not fork projects from this group to external namespaces.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#prevent_forking_outside_group Group#prevent_forking_outside_group}

project_creation_levelOptional
  • Type: str

Determine if developers can create projects in the group. Valid values are: noone, maintainer, developer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#project_creation_level Group#project_creation_level}

push_rulesOptional

push_rules block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#push_rules Group#push_rules}

request_access_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow users to request member access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#request_access_enabled Group#request_access_enabled}

require_two_factor_authenticationOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Require all users in this group to setup Two-factor authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#require_two_factor_authentication Group#require_two_factor_authentication}

shared_runners_minutes_limitOptional
  • Type: typing.Union[int, float]

Can be set by administrators only.

Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#shared_runners_minutes_limit Group#shared_runners_minutes_limit}

shared_runners_settingOptional
  • Type: str

Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#shared_runners_setting Group#shared_runners_setting}

share_with_group_lockOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Prevent sharing a project with another group within this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#share_with_group_lock Group#share_with_group_lock}

subgroup_creation_levelOptional
  • Type: str

Allowed to create subgroups. Valid values are: owner, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#subgroup_creation_level Group#subgroup_creation_level}

two_factor_grace_periodOptional
  • Type: typing.Union[int, float]

Defaults to 48. Time before Two-factor authentication is enforced (in hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#two_factor_grace_period Group#two_factor_grace_period}

visibility_levelOptional
  • Type: str

The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#visibility_level Group#visibility_level}

wiki_access_levelOptional
  • Type: str

The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#wiki_access_level Group#wiki_access_level}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_push_rules No description.
reset_auto_devops_enabled No description.
reset_avatar No description.
reset_avatar_hash No description.
reset_default_branch_protection No description.
reset_description No description.
reset_emails_disabled No description.
reset_emails_enabled No description.
reset_extra_shared_runners_minutes_limit No description.
reset_id No description.
reset_ip_restriction_ranges No description.
reset_lfs_enabled No description.
reset_membership_lock No description.
reset_mentions_disabled No description.
reset_parent_id No description.
reset_prevent_forking_outside_group No description.
reset_project_creation_level No description.
reset_push_rules No description.
reset_request_access_enabled No description.
reset_require_two_factor_authentication No description.
reset_shared_runners_minutes_limit No description.
reset_shared_runners_setting No description.
reset_share_with_group_lock No description.
reset_subgroup_creation_level No description.
reset_two_factor_grace_period No description.
reset_visibility_level No description.
reset_wiki_access_level No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_push_rules 
def put_push_rules(
  author_email_regex: str = None,
  branch_name_regex: str = None,
  commit_committer_check: typing.Union[bool, IResolvable] = None,
  commit_message_negative_regex: str = None,
  commit_message_regex: str = None,
  deny_delete_tag: typing.Union[bool, IResolvable] = None,
  file_name_regex: str = None,
  max_file_size: typing.Union[int, float] = None,
  member_check: typing.Union[bool, IResolvable] = None,
  prevent_secrets: typing.Union[bool, IResolvable] = None,
  reject_unsigned_commits: typing.Union[bool, IResolvable] = None
) -> None
author_email_regexOptional
  • Type: str

All commit author emails must match this regex, e.g. @my-company.com$.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#author_email_regex Group#author_email_regex}

branch_name_regexOptional
  • Type: str

All branch names must match this regex, e.g. (feature|hotfix)\/*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#branch_name_regex Group#branch_name_regex}

commit_committer_checkOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Only commits pushed using verified emails are allowed.

Note This attribute is only supported in GitLab versions >= 16.4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_committer_check Group#commit_committer_check}

commit_message_negative_regexOptional
  • Type: str

No commit message is allowed to match this regex, for example ssh\:\/\/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_message_negative_regex Group#commit_message_negative_regex}

commit_message_regexOptional
  • Type: str

All commit messages must match this regex, e.g. Fixed \d+\..*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_message_regex Group#commit_message_regex}

deny_delete_tagOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Deny deleting a tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#deny_delete_tag Group#deny_delete_tag}

file_name_regexOptional
  • Type: str

Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#file_name_regex Group#file_name_regex}

max_file_sizeOptional
  • Type: typing.Union[int, float]

Maximum file size (MB) allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#max_file_size Group#max_file_size}

member_checkOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Allows only GitLab users to author commits.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#member_check Group#member_check}

prevent_secretsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

GitLab will reject any files that are likely to contain secrets.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#prevent_secrets Group#prevent_secrets}

reject_unsigned_commitsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Only commits signed through GPG are allowed. Note This attribute is only supported in GitLab versions >= 16.4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#reject_unsigned_commits Group#reject_unsigned_commits}

reset_auto_devops_enabled 
def reset_auto_devops_enabled() -> None
reset_avatar 
def reset_avatar() -> None
reset_avatar_hash 
def reset_avatar_hash() -> None
reset_default_branch_protection 
def reset_default_branch_protection() -> None
reset_description 
def reset_description() -> None
reset_emails_disabled 
def reset_emails_disabled() -> None
reset_emails_enabled 
def reset_emails_enabled() -> None
reset_extra_shared_runners_minutes_limit 
def reset_extra_shared_runners_minutes_limit() -> None
reset_id 
def reset_id() -> None
reset_ip_restriction_ranges 
def reset_ip_restriction_ranges() -> None
reset_lfs_enabled 
def reset_lfs_enabled() -> None
reset_membership_lock 
def reset_membership_lock() -> None
reset_mentions_disabled 
def reset_mentions_disabled() -> None
reset_parent_id 
def reset_parent_id() -> None
reset_prevent_forking_outside_group 
def reset_prevent_forking_outside_group() -> None
reset_project_creation_level 
def reset_project_creation_level() -> None
reset_push_rules 
def reset_push_rules() -> None
reset_request_access_enabled 
def reset_request_access_enabled() -> None
reset_require_two_factor_authentication 
def reset_require_two_factor_authentication() -> None
reset_shared_runners_minutes_limit 
def reset_shared_runners_minutes_limit() -> None
reset_shared_runners_setting 
def reset_shared_runners_setting() -> None
reset_share_with_group_lock 
def reset_share_with_group_lock() -> None
reset_subgroup_creation_level 
def reset_subgroup_creation_level() -> None
reset_two_factor_grace_period 
def reset_two_factor_grace_period() -> None
reset_visibility_level 
def reset_visibility_level() -> None
reset_wiki_access_level 
def reset_wiki_access_level() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a Group resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_gitlab import group

group.Group.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_gitlab import group

group.Group.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_gitlab import group

group.Group.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_gitlab import group

group.Group.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a Group resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the Group to import.

import_from_idRequired
  • Type: str

The id of the existing Group that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Group to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
avatar_url str No description.
full_name str No description.
full_path str No description.
push_rules GroupPushRulesOutputReference No description.
runners_token str No description.
web_url str No description.
auto_devops_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
avatar_hash_input str No description.
avatar_input str No description.
default_branch_protection_input typing.Union[int, float] No description.
description_input str No description.
emails_disabled_input typing.Union[bool, cdktf.IResolvable] No description.
emails_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
extra_shared_runners_minutes_limit_input typing.Union[int, float] No description.
id_input str No description.
ip_restriction_ranges_input typing.List[str] No description.
lfs_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
membership_lock_input typing.Union[bool, cdktf.IResolvable] No description.
mentions_disabled_input typing.Union[bool, cdktf.IResolvable] No description.
name_input str No description.
parent_id_input typing.Union[int, float] No description.
path_input str No description.
prevent_forking_outside_group_input typing.Union[bool, cdktf.IResolvable] No description.
project_creation_level_input str No description.
push_rules_input GroupPushRules No description.
request_access_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
require_two_factor_authentication_input typing.Union[bool, cdktf.IResolvable] No description.
shared_runners_minutes_limit_input typing.Union[int, float] No description.
shared_runners_setting_input str No description.
share_with_group_lock_input typing.Union[bool, cdktf.IResolvable] No description.
subgroup_creation_level_input str No description.
two_factor_grace_period_input typing.Union[int, float] No description.
visibility_level_input str No description.
wiki_access_level_input str No description.
auto_devops_enabled typing.Union[bool, cdktf.IResolvable] No description.
avatar str No description.
avatar_hash str No description.
default_branch_protection typing.Union[int, float] No description.
description str No description.
emails_disabled typing.Union[bool, cdktf.IResolvable] No description.
emails_enabled typing.Union[bool, cdktf.IResolvable] No description.
extra_shared_runners_minutes_limit typing.Union[int, float] No description.
id str No description.
ip_restriction_ranges typing.List[str] No description.
lfs_enabled typing.Union[bool, cdktf.IResolvable] No description.
membership_lock typing.Union[bool, cdktf.IResolvable] No description.
mentions_disabled typing.Union[bool, cdktf.IResolvable] No description.
name str No description.
parent_id typing.Union[int, float] No description.
path str No description.
prevent_forking_outside_group typing.Union[bool, cdktf.IResolvable] No description.
project_creation_level str No description.
request_access_enabled typing.Union[bool, cdktf.IResolvable] No description.
require_two_factor_authentication typing.Union[bool, cdktf.IResolvable] No description.
shared_runners_minutes_limit typing.Union[int, float] No description.
shared_runners_setting str No description.
share_with_group_lock typing.Union[bool, cdktf.IResolvable] No description.
subgroup_creation_level str No description.
two_factor_grace_period typing.Union[int, float] No description.
visibility_level str No description.
wiki_access_level str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
avatar_urlRequired 
avatar_url: str
  • Type: str
full_nameRequired 
full_name: str
  • Type: str
full_pathRequired 
full_path: str
  • Type: str
push_rulesRequired 
push_rules: GroupPushRulesOutputReference
runners_tokenRequired 
runners_token: str
  • Type: str
web_urlRequired 
web_url: str
  • Type: str
auto_devops_enabled_inputOptional 
auto_devops_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
avatar_hash_inputOptional 
avatar_hash_input: str
  • Type: str
avatar_inputOptional 
avatar_input: str
  • Type: str
default_branch_protection_inputOptional 
default_branch_protection_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
description_inputOptional 
description_input: str
  • Type: str
emails_disabled_inputOptional 
emails_disabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
emails_enabled_inputOptional 
emails_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
extra_shared_runners_minutes_limit_inputOptional 
extra_shared_runners_minutes_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
id_inputOptional 
id_input: str
  • Type: str
ip_restriction_ranges_inputOptional 
ip_restriction_ranges_input: typing.List[str]
  • Type: typing.List[str]
lfs_enabled_inputOptional 
lfs_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
membership_lock_inputOptional 
membership_lock_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
mentions_disabled_inputOptional 
mentions_disabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
name_inputOptional 
name_input: str
  • Type: str
parent_id_inputOptional 
parent_id_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
path_inputOptional 
path_input: str
  • Type: str
prevent_forking_outside_group_inputOptional 
prevent_forking_outside_group_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
project_creation_level_inputOptional 
project_creation_level_input: str
  • Type: str
push_rules_inputOptional 
push_rules_input: GroupPushRules
request_access_enabled_inputOptional 
request_access_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_two_factor_authentication_inputOptional 
require_two_factor_authentication_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
shared_runners_minutes_limit_inputOptional 
shared_runners_minutes_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
shared_runners_setting_inputOptional 
shared_runners_setting_input: str
  • Type: str
share_with_group_lock_inputOptional 
share_with_group_lock_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
subgroup_creation_level_inputOptional 
subgroup_creation_level_input: str
  • Type: str
two_factor_grace_period_inputOptional 
two_factor_grace_period_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
visibility_level_inputOptional 
visibility_level_input: str
  • Type: str
wiki_access_level_inputOptional 
wiki_access_level_input: str
  • Type: str
auto_devops_enabledRequired 
auto_devops_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
avatarRequired 
avatar: str
  • Type: str
avatar_hashRequired 
avatar_hash: str
  • Type: str
default_branch_protectionRequired 
default_branch_protection: typing.Union[int, float]
  • Type: typing.Union[int, float]
descriptionRequired 
description: str
  • Type: str
emails_disabledRequired 
emails_disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
emails_enabledRequired 
emails_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
extra_shared_runners_minutes_limitRequired 
extra_shared_runners_minutes_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]
idRequired 
id: str
  • Type: str
ip_restriction_rangesRequired 
ip_restriction_ranges: typing.List[str]
  • Type: typing.List[str]
lfs_enabledRequired 
lfs_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
membership_lockRequired 
membership_lock: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
mentions_disabledRequired 
mentions_disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
nameRequired 
name: str
  • Type: str
parent_idRequired 
parent_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
pathRequired 
path: str
  • Type: str
prevent_forking_outside_groupRequired 
prevent_forking_outside_group: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
project_creation_levelRequired 
project_creation_level: str
  • Type: str
request_access_enabledRequired 
request_access_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
require_two_factor_authenticationRequired 
require_two_factor_authentication: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
shared_runners_minutes_limitRequired 
shared_runners_minutes_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]
shared_runners_settingRequired 
shared_runners_setting: str
  • Type: str
share_with_group_lockRequired 
share_with_group_lock: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
subgroup_creation_levelRequired 
subgroup_creation_level: str
  • Type: str
two_factor_grace_periodRequired 
two_factor_grace_period: typing.Union[int, float]
  • Type: typing.Union[int, float]
visibility_levelRequired 
visibility_level: str
  • Type: str
wiki_access_levelRequired 
wiki_access_level: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

GroupConfig

Initializer 

from cdktf_cdktf_provider_gitlab import group

group.GroupConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  path: str,
  auto_devops_enabled: typing.Union[bool, IResolvable] = None,
  avatar: str = None,
  avatar_hash: str = None,
  default_branch_protection: typing.Union[int, float] = None,
  description: str = None,
  emails_disabled: typing.Union[bool, IResolvable] = None,
  emails_enabled: typing.Union[bool, IResolvable] = None,
  extra_shared_runners_minutes_limit: typing.Union[int, float] = None,
  id: str = None,
  ip_restriction_ranges: typing.List[str] = None,
  lfs_enabled: typing.Union[bool, IResolvable] = None,
  membership_lock: typing.Union[bool, IResolvable] = None,
  mentions_disabled: typing.Union[bool, IResolvable] = None,
  parent_id: typing.Union[int, float] = None,
  prevent_forking_outside_group: typing.Union[bool, IResolvable] = None,
  project_creation_level: str = None,
  push_rules: GroupPushRules = None,
  request_access_enabled: typing.Union[bool, IResolvable] = None,
  require_two_factor_authentication: typing.Union[bool, IResolvable] = None,
  shared_runners_minutes_limit: typing.Union[int, float] = None,
  shared_runners_setting: str = None,
  share_with_group_lock: typing.Union[bool, IResolvable] = None,
  subgroup_creation_level: str = None,
  two_factor_grace_period: typing.Union[int, float] = None,
  visibility_level: str = None,
  wiki_access_level: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The name of the group.
path str The path of the group.
auto_devops_enabled typing.Union[bool, cdktf.IResolvable] Default to Auto DevOps pipeline for all projects within this group.
avatar str A local path to the avatar image to upload. Note: not available for imported resources.
avatar_hash str The hash of the avatar image.
default_branch_protection typing.Union[int, float] See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection. Valid values are: 0, 1, 2, 3, 4.
description str The group's description.
emails_disabled typing.Union[bool, cdktf.IResolvable] Disable email notifications.
emails_enabled typing.Union[bool, cdktf.IResolvable] Enable email notifications.
extra_shared_runners_minutes_limit typing.Union[int, float] Can be set by administrators only. Additional CI/CD minutes for this group.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#id Group#id}.
ip_restriction_ranges typing.List[str] A list of IP addresses or subnet masks to restrict group access.
lfs_enabled typing.Union[bool, cdktf.IResolvable] Enable/disable Large File Storage (LFS) for the projects in this group.
membership_lock typing.Union[bool, cdktf.IResolvable] Users cannot be added to projects in this group.
mentions_disabled typing.Union[bool, cdktf.IResolvable] Disable the capability of a group from getting mentioned.
parent_id typing.Union[int, float] Id of the parent group (creates a nested group).
prevent_forking_outside_group typing.Union[bool, cdktf.IResolvable] Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
project_creation_level str Determine if developers can create projects in the group. Valid values are: noone, maintainer, developer.
push_rules GroupPushRules push_rules block.
request_access_enabled typing.Union[bool, cdktf.IResolvable] Allow users to request member access.
require_two_factor_authentication typing.Union[bool, cdktf.IResolvable] Require all users in this group to setup Two-factor authentication.
shared_runners_minutes_limit typing.Union[int, float] Can be set by administrators only.
shared_runners_setting str Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.
share_with_group_lock typing.Union[bool, cdktf.IResolvable] Prevent sharing a project with another group within this group.
subgroup_creation_level str Allowed to create subgroups. Valid values are: owner, maintainer.
two_factor_grace_period typing.Union[int, float] 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. Valid values are: private, internal, public.
wiki_access_level str The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired 
name: str
  • Type: str

The name of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#name Group#name}

pathRequired 
path: str
  • Type: str

The path of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#path Group#path}

auto_devops_enabledOptional 
auto_devops_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Default to Auto DevOps pipeline for all projects within this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#auto_devops_enabled Group#auto_devops_enabled}

avatarOptional 
avatar: str
  • Type: str

A local path to the avatar image to upload. Note: not available for imported resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#avatar Group#avatar}

avatar_hashOptional 
avatar_hash: str
  • Type: str

The hash of the avatar image.

Use filesha256("path/to/avatar.png") whenever possible. Note: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#avatar_hash Group#avatar_hash}

default_branch_protectionOptional 
default_branch_protection: typing.Union[int, float]
  • Type: typing.Union[int, float]

See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection. Valid values are: 0, 1, 2, 3, 4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#default_branch_protection Group#default_branch_protection}

descriptionOptional 
description: str
  • Type: str

The group's description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#description Group#description}

emails_disabledOptional 
emails_disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Disable email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#emails_disabled Group#emails_disabled}

emails_enabledOptional 
emails_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable email notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#emails_enabled Group#emails_enabled}

extra_shared_runners_minutes_limitOptional 
extra_shared_runners_minutes_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

Can be set by administrators only. Additional CI/CD minutes for this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#extra_shared_runners_minutes_limit Group#extra_shared_runners_minutes_limit}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#id Group#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

ip_restriction_rangesOptional 
ip_restriction_ranges: typing.List[str]
  • Type: typing.List[str]

A list of IP addresses or subnet masks to restrict group access.

Will be concatenated together into a comma separated string. Only allowed on top level groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#ip_restriction_ranges Group#ip_restriction_ranges}

lfs_enabledOptional 
lfs_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Enable/disable Large File Storage (LFS) for the projects in this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#lfs_enabled Group#lfs_enabled}

membership_lockOptional 
membership_lock: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Users cannot be added to projects in this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#membership_lock Group#membership_lock}

mentions_disabledOptional 
mentions_disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Disable the capability of a group from getting mentioned.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#mentions_disabled Group#mentions_disabled}

parent_idOptional 
parent_id: typing.Union[int, float]
  • Type: typing.Union[int, float]

Id of the parent group (creates a nested group).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#parent_id Group#parent_id}

prevent_forking_outside_groupOptional 
prevent_forking_outside_group: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Defaults to false. When enabled, users can not fork projects from this group to external namespaces.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#prevent_forking_outside_group Group#prevent_forking_outside_group}

project_creation_levelOptional 
project_creation_level: str
  • Type: str

Determine if developers can create projects in the group. Valid values are: noone, maintainer, developer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#project_creation_level Group#project_creation_level}

push_rulesOptional 
push_rules: GroupPushRules

push_rules block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#push_rules Group#push_rules}

request_access_enabledOptional 
request_access_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allow users to request member access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#request_access_enabled Group#request_access_enabled}

require_two_factor_authenticationOptional 
require_two_factor_authentication: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Require all users in this group to setup Two-factor authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#require_two_factor_authentication Group#require_two_factor_authentication}

shared_runners_minutes_limitOptional 
shared_runners_minutes_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

Can be set by administrators only.

Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#shared_runners_minutes_limit Group#shared_runners_minutes_limit}

shared_runners_settingOptional 
shared_runners_setting: str
  • Type: str

Enable or disable shared runners for a group’s subgroups and projects. Valid values are: enabled, disabled_and_overridable, disabled_and_unoverridable, disabled_with_override.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#shared_runners_setting Group#shared_runners_setting}

share_with_group_lockOptional 
share_with_group_lock: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Prevent sharing a project with another group within this group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#share_with_group_lock Group#share_with_group_lock}

subgroup_creation_levelOptional 
subgroup_creation_level: str
  • Type: str

Allowed to create subgroups. Valid values are: owner, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#subgroup_creation_level Group#subgroup_creation_level}

two_factor_grace_periodOptional 
two_factor_grace_period: typing.Union[int, float]
  • Type: typing.Union[int, float]

Defaults to 48. Time before Two-factor authentication is enforced (in hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#two_factor_grace_period Group#two_factor_grace_period}

visibility_levelOptional 
visibility_level: str
  • Type: str

The group's visibility. Can be private, internal, or public. Valid values are: private, internal, public.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#visibility_level Group#visibility_level}

wiki_access_levelOptional 
wiki_access_level: str
  • Type: str

The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#wiki_access_level Group#wiki_access_level}

GroupPushRules

Initializer 

from cdktf_cdktf_provider_gitlab import group

group.GroupPushRules(
  author_email_regex: str = None,
  branch_name_regex: str = None,
  commit_committer_check: typing.Union[bool, IResolvable] = None,
  commit_message_negative_regex: str = None,
  commit_message_regex: str = None,
  deny_delete_tag: typing.Union[bool, IResolvable] = None,
  file_name_regex: str = None,
  max_file_size: typing.Union[int, float] = None,
  member_check: typing.Union[bool, IResolvable] = None,
  prevent_secrets: typing.Union[bool, IResolvable] = None,
  reject_unsigned_commits: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
author_email_regex str All commit author emails must match this regex, e.g. @my-company.com$.
branch_name_regex str All branch names must match this regex, e.g. (feature|hotfix)\/*.
commit_committer_check typing.Union[bool, cdktf.IResolvable] Only commits pushed using verified emails are allowed.
commit_message_negative_regex str No commit message is allowed to match this regex, for example ssh\:\/\/.
commit_message_regex str All commit messages must match this regex, e.g. Fixed \d+\..*.
deny_delete_tag typing.Union[bool, cdktf.IResolvable] Deny deleting a tag.
file_name_regex str Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.
max_file_size typing.Union[int, float] Maximum file size (MB) allowed.
member_check typing.Union[bool, cdktf.IResolvable] Allows only GitLab users to author commits.
prevent_secrets typing.Union[bool, cdktf.IResolvable] GitLab will reject any files that are likely to contain secrets.
reject_unsigned_commits typing.Union[bool, cdktf.IResolvable] Only commits signed through GPG are allowed. Note This attribute is only supported in GitLab versions >= 16.4.
author_email_regexOptional 
author_email_regex: str
  • Type: str

All commit author emails must match this regex, e.g. @my-company.com$.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#author_email_regex Group#author_email_regex}

branch_name_regexOptional 
branch_name_regex: str
  • Type: str

All branch names must match this regex, e.g. (feature|hotfix)\/*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#branch_name_regex Group#branch_name_regex}

commit_committer_checkOptional 
commit_committer_check: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Only commits pushed using verified emails are allowed.

Note This attribute is only supported in GitLab versions >= 16.4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_committer_check Group#commit_committer_check}

commit_message_negative_regexOptional 
commit_message_negative_regex: str
  • Type: str

No commit message is allowed to match this regex, for example ssh\:\/\/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_message_negative_regex Group#commit_message_negative_regex}

commit_message_regexOptional 
commit_message_regex: str
  • Type: str

All commit messages must match this regex, e.g. Fixed \d+\..*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#commit_message_regex Group#commit_message_regex}

deny_delete_tagOptional 
deny_delete_tag: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Deny deleting a tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#deny_delete_tag Group#deny_delete_tag}

file_name_regexOptional 
file_name_regex: str
  • Type: str

Filenames matching the regular expression provided in this attribute are not allowed, for example, (jar|exe)$.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#file_name_regex Group#file_name_regex}

max_file_sizeOptional 
max_file_size: typing.Union[int, float]
  • Type: typing.Union[int, float]

Maximum file size (MB) allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#max_file_size Group#max_file_size}

member_checkOptional 
member_check: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Allows only GitLab users to author commits.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#member_check Group#member_check}

prevent_secretsOptional 
prevent_secrets: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

GitLab will reject any files that are likely to contain secrets.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#prevent_secrets Group#prevent_secrets}

reject_unsigned_commitsOptional 
reject_unsigned_commits: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Only commits signed through GPG are allowed. Note This attribute is only supported in GitLab versions >= 16.4.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/16.11.0/docs/resources/group#reject_unsigned_commits Group#reject_unsigned_commits}

Classes

GroupPushRulesOutputReference

Initializers 

from cdktf_cdktf_provider_gitlab import group

group.GroupPushRulesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_author_email_regex No description.
reset_branch_name_regex No description.
reset_commit_committer_check No description.
reset_commit_message_negative_regex No description.
reset_commit_message_regex No description.
reset_deny_delete_tag No description.
reset_file_name_regex No description.
reset_max_file_size No description.
reset_member_check No description.
reset_prevent_secrets No description.
reset_reject_unsigned_commits No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_author_email_regex 
def reset_author_email_regex() -> None
reset_branch_name_regex 
def reset_branch_name_regex() -> None
reset_commit_committer_check 
def reset_commit_committer_check() -> None
reset_commit_message_negative_regex 
def reset_commit_message_negative_regex() -> None
reset_commit_message_regex 
def reset_commit_message_regex() -> None
reset_deny_delete_tag 
def reset_deny_delete_tag() -> None
reset_file_name_regex 
def reset_file_name_regex() -> None
reset_max_file_size 
def reset_max_file_size() -> None
reset_member_check 
def reset_member_check() -> None
reset_prevent_secrets 
def reset_prevent_secrets() -> None
reset_reject_unsigned_commits 
def reset_reject_unsigned_commits() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
author_email_regex_input str No description.
branch_name_regex_input str No description.
commit_committer_check_input typing.Union[bool, cdktf.IResolvable] No description.
commit_message_negative_regex_input str No description.
commit_message_regex_input str No description.
deny_delete_tag_input typing.Union[bool, cdktf.IResolvable] No description.
file_name_regex_input str No description.
max_file_size_input typing.Union[int, float] No description.
member_check_input typing.Union[bool, cdktf.IResolvable] No description.
prevent_secrets_input typing.Union[bool, cdktf.IResolvable] No description.
reject_unsigned_commits_input typing.Union[bool, cdktf.IResolvable] No description.
author_email_regex str No description.
branch_name_regex str No description.
commit_committer_check typing.Union[bool, cdktf.IResolvable] No description.
commit_message_negative_regex str No description.
commit_message_regex str No description.
deny_delete_tag typing.Union[bool, cdktf.IResolvable] No description.
file_name_regex str No description.
max_file_size typing.Union[int, float] No description.
member_check typing.Union[bool, cdktf.IResolvable] No description.
prevent_secrets typing.Union[bool, cdktf.IResolvable] No description.
reject_unsigned_commits typing.Union[bool, cdktf.IResolvable] No description.
internal_value GroupPushRules No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
author_email_regex_inputOptional 
author_email_regex_input: str
  • Type: str
branch_name_regex_inputOptional 
branch_name_regex_input: str
  • Type: str
commit_committer_check_inputOptional 
commit_committer_check_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
commit_message_negative_regex_inputOptional 
commit_message_negative_regex_input: str
  • Type: str
commit_message_regex_inputOptional 
commit_message_regex_input: str
  • Type: str
deny_delete_tag_inputOptional 
deny_delete_tag_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
file_name_regex_inputOptional 
file_name_regex_input: str
  • Type: str
max_file_size_inputOptional 
max_file_size_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
member_check_inputOptional 
member_check_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
prevent_secrets_inputOptional 
prevent_secrets_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
reject_unsigned_commits_inputOptional 
reject_unsigned_commits_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
author_email_regexRequired 
author_email_regex: str
  • Type: str
branch_name_regexRequired 
branch_name_regex: str
  • Type: str
commit_committer_checkRequired 
commit_committer_check: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
commit_message_negative_regexRequired 
commit_message_negative_regex: str
  • Type: str
commit_message_regexRequired 
commit_message_regex: str
  • Type: str
deny_delete_tagRequired 
deny_delete_tag: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
file_name_regexRequired 
file_name_regex: str
  • Type: str
max_file_sizeRequired 
max_file_size: typing.Union[int, float]
  • Type: typing.Union[int, float]
member_checkRequired 
member_check: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
prevent_secretsRequired 
prevent_secrets: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
reject_unsigned_commitsRequired 
reject_unsigned_commits: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
internal_valueOptional 
internal_value: GroupPushRules