GitLab v8.1.0, Jun 21 24

GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi

gitlab.getProject

Explore with Pulumi AI

GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi

Using getProject

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>

def get_project(ci_default_git_depth: Optional[int] = None,
                id: Optional[str] = None,
                path_with_namespace: Optional[str] = None,
                public_builds: Optional[bool] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(ci_default_git_depth: Optional[pulumi.Input[int]] = None,
                id: Optional[pulumi.Input[str]] = None,
                path_with_namespace: Optional[pulumi.Input[str]] = None,
                public_builds: Optional[pulumi.Input[bool]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]

func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

> Note: This function is named LookupProject in the Go SDK.

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: gitlab:index/getProject:getProject
  arguments:
    # arguments dictionary

The following arguments are supported:

CiDefaultGitDepth int: Default number of revisions for shallow cloning.
Id string: The integer that uniquely identifies the project within the gitlab install.
PathWithNamespace string: The path of the repository with namespace.
PublicBuilds bool: If true, jobs can be viewed by non-project members.

CiDefaultGitDepth int: Default number of revisions for shallow cloning.
Id string: The integer that uniquely identifies the project within the gitlab install.
PathWithNamespace string: The path of the repository with namespace.
PublicBuilds bool: If true, jobs can be viewed by non-project members.

ciDefaultGitDepth Integer: Default number of revisions for shallow cloning.
id String: The integer that uniquely identifies the project within the gitlab install.
pathWithNamespace String: The path of the repository with namespace.
publicBuilds Boolean: If true, jobs can be viewed by non-project members.

ciDefaultGitDepth number: Default number of revisions for shallow cloning.
id string: The integer that uniquely identifies the project within the gitlab install.
pathWithNamespace string: The path of the repository with namespace.
publicBuilds boolean: If true, jobs can be viewed by non-project members.

ci_default_git_depth int: Default number of revisions for shallow cloning.
id str: The integer that uniquely identifies the project within the gitlab install.
path_with_namespace str: The path of the repository with namespace.
public_builds bool: If true, jobs can be viewed by non-project members.

ciDefaultGitDepth Number: Default number of revisions for shallow cloning.
id String: The integer that uniquely identifies the project within the gitlab install.
pathWithNamespace String: The path of the repository with namespace.
publicBuilds Boolean: If true, jobs can be viewed by non-project members.

getProject Result

The following output properties are available:

AnalyticsAccessLevel string: Set the analytics access level. Valid values are disabled, private, enabled.
Archived bool: Whether the project is in read-only mode (archived).
AutoCancelPendingPipelines string: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
AutoDevopsDeployStrategy string: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
AutoDevopsEnabled bool: Enable Auto DevOps for this project.
AutocloseReferencedIssues bool: Set whether auto-closing referenced issues on default branch.
BuildGitStrategy string: The Git strategy. Defaults to fetch.
BuildTimeout int: The maximum amount of time, in seconds, that a job can run.
BuildsAccessLevel string: Set the builds access level. Valid values are disabled, private, enabled.
CiConfigPath string: CI config file path for the project.
CiDefaultGitDepth int: Default number of revisions for shallow cloning.
CiRestrictPipelineCancellationRole string: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
CiSeparatedCaches bool: Use separate caches for protected branches.
ContainerExpirationPolicies List<Pulumi.GitLab.Outputs.GetProjectContainerExpirationPolicy>: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
ContainerRegistryAccessLevel string: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
EmailsEnabled bool: Enable email notifications.
EmptyRepo bool: Whether the project is empty.
EnvironmentsAccessLevel string: Set the environments access level. Valid values are disabled, private, enabled.
ExternalAuthorizationClassificationLabel string: The classification label for the project.
FeatureFlagsAccessLevel string: Set the feature flags access level. Valid values are disabled, private, enabled.
ForkingAccessLevel string: Set the forking access level. Valid values are disabled, private, enabled.
HttpUrlToRepo string: URL that can be provided to git clone to clone the
Id string: The integer that uniquely identifies the project within the gitlab install.
ImportUrl string: URL the project was imported from.
InfrastructureAccessLevel string: Set the infrastructure access level. Valid values are disabled, private, enabled.
IssuesAccessLevel string: Set the issues access level. Valid values are disabled, private, enabled.
IssuesEnabled bool: Enable issue tracking for the project.
KeepLatestArtifact bool: Disable or enable the ability to keep the latest artifact for this project.
LfsEnabled bool: Enable LFS for the project.
MergeCommitTemplate string: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
MergePipelinesEnabled bool: Enable or disable merge pipelines.
MergeRequestsAccessLevel string: Set the merge requests access level. Valid values are disabled, private, enabled.
MergeRequestsEnabled bool: Enable merge requests for the project.
MergeTrainsEnabled bool: Enable or disable merge trains.
MonitorAccessLevel string: Set the monitor access level. Valid values are disabled, private, enabled.
Name string: The name of the project.
NamespaceId int: The namespace (group or user) of the project. Defaults to your user.
Path string: The path of the repository.
PathWithNamespace string: The path of the repository with namespace.
PipelinesEnabled bool: Enable pipelines for the project.
PrintingMergeRequestLinkEnabled bool: Show link to create/view merge request when pushing from the command line
PushRules List<Pulumi.GitLab.Outputs.GetProjectPushRule>: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
ReleasesAccessLevel string: Set the releases access level. Valid values are disabled, private, enabled.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RepositoryAccessLevel string: Set the repository access level. Valid values are disabled, private, enabled.
RepositoryStorage string: Which storage shard the repository is on. (administrator only)
RequestAccessEnabled bool: Allow users to request member access.
RequirementsAccessLevel string: Set the requirements access level. Valid values are disabled, private, enabled.
ResolveOutdatedDiffDiscussions bool: Automatically resolve merge request diffs discussions on lines changed with a push.
RestrictUserDefinedVariables bool: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
RunnersToken string: Registration token to use during runner setup.
SecurityAndComplianceAccessLevel string: Set the security and compliance access level. Valid values are disabled, private, enabled.
SharedWithGroups List<Pulumi.GitLab.Outputs.GetProjectSharedWithGroup>: Describes groups which have access shared to this project.
SnippetsAccessLevel string: Set the snippets access level. Valid values are disabled, private, enabled.
SnippetsEnabled bool: Enable snippets for the project.
SquashCommitTemplate string: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
SshUrlToRepo string: URL that can be provided to git clone to clone the
SuggestionCommitMessage string: The commit message used to apply merge request suggestions.
Topics List<string>: The list of topics for the project.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiAccessLevel string: Set the wiki access level. Valid values are disabled, private, enabled.
WikiEnabled bool: Enable wiki for the project.
PublicBuilds bool: If true, jobs can be viewed by non-project members.

AnalyticsAccessLevel string: Set the analytics access level. Valid values are disabled, private, enabled.
Archived bool: Whether the project is in read-only mode (archived).
AutoCancelPendingPipelines string: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
AutoDevopsDeployStrategy string: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
AutoDevopsEnabled bool: Enable Auto DevOps for this project.
AutocloseReferencedIssues bool: Set whether auto-closing referenced issues on default branch.
BuildGitStrategy string: The Git strategy. Defaults to fetch.
BuildTimeout int: The maximum amount of time, in seconds, that a job can run.
BuildsAccessLevel string: Set the builds access level. Valid values are disabled, private, enabled.
CiConfigPath string: CI config file path for the project.
CiDefaultGitDepth int: Default number of revisions for shallow cloning.
CiRestrictPipelineCancellationRole string: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
CiSeparatedCaches bool: Use separate caches for protected branches.
ContainerExpirationPolicies []GetProjectContainerExpirationPolicy: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
ContainerRegistryAccessLevel string: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
DefaultBranch string: The default branch for the project.
Description string: A description of the project.
EmailsEnabled bool: Enable email notifications.
EmptyRepo bool: Whether the project is empty.
EnvironmentsAccessLevel string: Set the environments access level. Valid values are disabled, private, enabled.
ExternalAuthorizationClassificationLabel string: The classification label for the project.
FeatureFlagsAccessLevel string: Set the feature flags access level. Valid values are disabled, private, enabled.
ForkingAccessLevel string: Set the forking access level. Valid values are disabled, private, enabled.
HttpUrlToRepo string: URL that can be provided to git clone to clone the
Id string: The integer that uniquely identifies the project within the gitlab install.
ImportUrl string: URL the project was imported from.
InfrastructureAccessLevel string: Set the infrastructure access level. Valid values are disabled, private, enabled.
IssuesAccessLevel string: Set the issues access level. Valid values are disabled, private, enabled.
IssuesEnabled bool: Enable issue tracking for the project.
KeepLatestArtifact bool: Disable or enable the ability to keep the latest artifact for this project.
LfsEnabled bool: Enable LFS for the project.
MergeCommitTemplate string: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
MergePipelinesEnabled bool: Enable or disable merge pipelines.
MergeRequestsAccessLevel string: Set the merge requests access level. Valid values are disabled, private, enabled.
MergeRequestsEnabled bool: Enable merge requests for the project.
MergeTrainsEnabled bool: Enable or disable merge trains.
MonitorAccessLevel string: Set the monitor access level. Valid values are disabled, private, enabled.
Name string: The name of the project.
NamespaceId int: The namespace (group or user) of the project. Defaults to your user.
Path string: The path of the repository.
PathWithNamespace string: The path of the repository with namespace.
PipelinesEnabled bool: Enable pipelines for the project.
PrintingMergeRequestLinkEnabled bool: Show link to create/view merge request when pushing from the command line
PushRules []GetProjectPushRule: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
ReleasesAccessLevel string: Set the releases access level. Valid values are disabled, private, enabled.
RemoveSourceBranchAfterMerge bool: Enable Delete source branch option by default for all new merge requests
RepositoryAccessLevel string: Set the repository access level. Valid values are disabled, private, enabled.
RepositoryStorage string: Which storage shard the repository is on. (administrator only)
RequestAccessEnabled bool: Allow users to request member access.
RequirementsAccessLevel string: Set the requirements access level. Valid values are disabled, private, enabled.
ResolveOutdatedDiffDiscussions bool: Automatically resolve merge request diffs discussions on lines changed with a push.
RestrictUserDefinedVariables bool: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
RunnersToken string: Registration token to use during runner setup.
SecurityAndComplianceAccessLevel string: Set the security and compliance access level. Valid values are disabled, private, enabled.
SharedWithGroups []GetProjectSharedWithGroup: Describes groups which have access shared to this project.
SnippetsAccessLevel string: Set the snippets access level. Valid values are disabled, private, enabled.
SnippetsEnabled bool: Enable snippets for the project.
SquashCommitTemplate string: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
SshUrlToRepo string: URL that can be provided to git clone to clone the
SuggestionCommitMessage string: The commit message used to apply merge request suggestions.
Topics []string: The list of topics for the project.
VisibilityLevel string: Repositories are created as private by default.
WebUrl string: URL that can be used to find the project in a browser.
WikiAccessLevel string: Set the wiki access level. Valid values are disabled, private, enabled.
WikiEnabled bool: Enable wiki for the project.
PublicBuilds bool: If true, jobs can be viewed by non-project members.

analyticsAccessLevel String: Set the analytics access level. Valid values are disabled, private, enabled.
archived Boolean: Whether the project is in read-only mode (archived).
autoCancelPendingPipelines String: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
autoDevopsDeployStrategy String: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
autoDevopsEnabled Boolean: Enable Auto DevOps for this project.
autocloseReferencedIssues Boolean: Set whether auto-closing referenced issues on default branch.
buildGitStrategy String: The Git strategy. Defaults to fetch.
buildTimeout Integer: The maximum amount of time, in seconds, that a job can run.
buildsAccessLevel String: Set the builds access level. Valid values are disabled, private, enabled.
ciConfigPath String: CI config file path for the project.
ciDefaultGitDepth Integer: Default number of revisions for shallow cloning.
ciRestrictPipelineCancellationRole String: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
ciSeparatedCaches Boolean: Use separate caches for protected branches.
containerExpirationPolicies List<GetProjectContainerExpirationPolicy>: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
containerRegistryAccessLevel String: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
defaultBranch String: The default branch for the project.
description String: A description of the project.
emailsEnabled Boolean: Enable email notifications.
emptyRepo Boolean: Whether the project is empty.
environmentsAccessLevel String: Set the environments access level. Valid values are disabled, private, enabled.
externalAuthorizationClassificationLabel String: The classification label for the project.
featureFlagsAccessLevel String: Set the feature flags access level. Valid values are disabled, private, enabled.
forkingAccessLevel String: Set the forking access level. Valid values are disabled, private, enabled.
httpUrlToRepo String: URL that can be provided to git clone to clone the
id String: The integer that uniquely identifies the project within the gitlab install.
importUrl String: URL the project was imported from.
infrastructureAccessLevel String: Set the infrastructure access level. Valid values are disabled, private, enabled.
issuesAccessLevel String: Set the issues access level. Valid values are disabled, private, enabled.
issuesEnabled Boolean: Enable issue tracking for the project.
keepLatestArtifact Boolean: Disable or enable the ability to keep the latest artifact for this project.
lfsEnabled Boolean: Enable LFS for the project.
mergeCommitTemplate String: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
mergePipelinesEnabled Boolean: Enable or disable merge pipelines.
mergeRequestsAccessLevel String: Set the merge requests access level. Valid values are disabled, private, enabled.
mergeRequestsEnabled Boolean: Enable merge requests for the project.
mergeTrainsEnabled Boolean: Enable or disable merge trains.
monitorAccessLevel String: Set the monitor access level. Valid values are disabled, private, enabled.
name String: The name of the project.
namespaceId Integer: The namespace (group or user) of the project. Defaults to your user.
path String: The path of the repository.
pathWithNamespace String: The path of the repository with namespace.
pipelinesEnabled Boolean: Enable pipelines for the project.
printingMergeRequestLinkEnabled Boolean: Show link to create/view merge request when pushing from the command line
pushRules List<GetProjectPushRule>: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
releasesAccessLevel String: Set the releases access level. Valid values are disabled, private, enabled.
removeSourceBranchAfterMerge Boolean: Enable Delete source branch option by default for all new merge requests
repositoryAccessLevel String: Set the repository access level. Valid values are disabled, private, enabled.
repositoryStorage String: Which storage shard the repository is on. (administrator only)
requestAccessEnabled Boolean: Allow users to request member access.
requirementsAccessLevel String: Set the requirements access level. Valid values are disabled, private, enabled.
resolveOutdatedDiffDiscussions Boolean: Automatically resolve merge request diffs discussions on lines changed with a push.
restrictUserDefinedVariables Boolean: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
runnersToken String: Registration token to use during runner setup.
securityAndComplianceAccessLevel String: Set the security and compliance access level. Valid values are disabled, private, enabled.
sharedWithGroups List<GetProjectSharedWithGroup>: Describes groups which have access shared to this project.
snippetsAccessLevel String: Set the snippets access level. Valid values are disabled, private, enabled.
snippetsEnabled Boolean: Enable snippets for the project.
squashCommitTemplate String: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
sshUrlToRepo String: URL that can be provided to git clone to clone the
suggestionCommitMessage String: The commit message used to apply merge request suggestions.
topics List<String>: The list of topics for the project.
visibilityLevel String: Repositories are created as private by default.
webUrl String: URL that can be used to find the project in a browser.
wikiAccessLevel String: Set the wiki access level. Valid values are disabled, private, enabled.
wikiEnabled Boolean: Enable wiki for the project.
publicBuilds Boolean: If true, jobs can be viewed by non-project members.

analyticsAccessLevel string: Set the analytics access level. Valid values are disabled, private, enabled.
archived boolean: Whether the project is in read-only mode (archived).
autoCancelPendingPipelines string: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
autoDevopsDeployStrategy string: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
autoDevopsEnabled boolean: Enable Auto DevOps for this project.
autocloseReferencedIssues boolean: Set whether auto-closing referenced issues on default branch.
buildGitStrategy string: The Git strategy. Defaults to fetch.
buildTimeout number: The maximum amount of time, in seconds, that a job can run.
buildsAccessLevel string: Set the builds access level. Valid values are disabled, private, enabled.
ciConfigPath string: CI config file path for the project.
ciDefaultGitDepth number: Default number of revisions for shallow cloning.
ciRestrictPipelineCancellationRole string: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
ciSeparatedCaches boolean: Use separate caches for protected branches.
containerExpirationPolicies GetProjectContainerExpirationPolicy[]: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
containerRegistryAccessLevel string: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
defaultBranch string: The default branch for the project.
description string: A description of the project.
emailsEnabled boolean: Enable email notifications.
emptyRepo boolean: Whether the project is empty.
environmentsAccessLevel string: Set the environments access level. Valid values are disabled, private, enabled.
externalAuthorizationClassificationLabel string: The classification label for the project.
featureFlagsAccessLevel string: Set the feature flags access level. Valid values are disabled, private, enabled.
forkingAccessLevel string: Set the forking access level. Valid values are disabled, private, enabled.
httpUrlToRepo string: URL that can be provided to git clone to clone the
id string: The integer that uniquely identifies the project within the gitlab install.
importUrl string: URL the project was imported from.
infrastructureAccessLevel string: Set the infrastructure access level. Valid values are disabled, private, enabled.
issuesAccessLevel string: Set the issues access level. Valid values are disabled, private, enabled.
issuesEnabled boolean: Enable issue tracking for the project.
keepLatestArtifact boolean: Disable or enable the ability to keep the latest artifact for this project.
lfsEnabled boolean: Enable LFS for the project.
mergeCommitTemplate string: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
mergePipelinesEnabled boolean: Enable or disable merge pipelines.
mergeRequestsAccessLevel string: Set the merge requests access level. Valid values are disabled, private, enabled.
mergeRequestsEnabled boolean: Enable merge requests for the project.
mergeTrainsEnabled boolean: Enable or disable merge trains.
monitorAccessLevel string: Set the monitor access level. Valid values are disabled, private, enabled.
name string: The name of the project.
namespaceId number: The namespace (group or user) of the project. Defaults to your user.
path string: The path of the repository.
pathWithNamespace string: The path of the repository with namespace.
pipelinesEnabled boolean: Enable pipelines for the project.
printingMergeRequestLinkEnabled boolean: Show link to create/view merge request when pushing from the command line
pushRules GetProjectPushRule[]: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
releasesAccessLevel string: Set the releases access level. Valid values are disabled, private, enabled.
removeSourceBranchAfterMerge boolean: Enable Delete source branch option by default for all new merge requests
repositoryAccessLevel string: Set the repository access level. Valid values are disabled, private, enabled.
repositoryStorage string: Which storage shard the repository is on. (administrator only)
requestAccessEnabled boolean: Allow users to request member access.
requirementsAccessLevel string: Set the requirements access level. Valid values are disabled, private, enabled.
resolveOutdatedDiffDiscussions boolean: Automatically resolve merge request diffs discussions on lines changed with a push.
restrictUserDefinedVariables boolean: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
runnersToken string: Registration token to use during runner setup.
securityAndComplianceAccessLevel string: Set the security and compliance access level. Valid values are disabled, private, enabled.
sharedWithGroups GetProjectSharedWithGroup[]: Describes groups which have access shared to this project.
snippetsAccessLevel string: Set the snippets access level. Valid values are disabled, private, enabled.
snippetsEnabled boolean: Enable snippets for the project.
squashCommitTemplate string: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
sshUrlToRepo string: URL that can be provided to git clone to clone the
suggestionCommitMessage string: The commit message used to apply merge request suggestions.
topics string[]: The list of topics for the project.
visibilityLevel string: Repositories are created as private by default.
webUrl string: URL that can be used to find the project in a browser.
wikiAccessLevel string: Set the wiki access level. Valid values are disabled, private, enabled.
wikiEnabled boolean: Enable wiki for the project.
publicBuilds boolean: If true, jobs can be viewed by non-project members.

analytics_access_level str: Set the analytics access level. Valid values are disabled, private, enabled.
archived bool: Whether the project is in read-only mode (archived).
auto_cancel_pending_pipelines str: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
auto_devops_deploy_strategy str: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
auto_devops_enabled bool: Enable Auto DevOps for this project.
autoclose_referenced_issues bool: Set whether auto-closing referenced issues on default branch.
build_git_strategy str: The Git strategy. Defaults to fetch.
build_timeout int: The maximum amount of time, in seconds, that a job can run.
builds_access_level str: Set the builds access level. Valid values are disabled, private, enabled.
ci_config_path str: CI config file path for the project.
ci_default_git_depth int: Default number of revisions for shallow cloning.
ci_restrict_pipeline_cancellation_role str: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
ci_separated_caches bool: Use separate caches for protected branches.
container_expiration_policies Sequence[GetProjectContainerExpirationPolicy]: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
container_registry_access_level str: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
default_branch str: The default branch for the project.
description str: A description of the project.
emails_enabled bool: Enable email notifications.
empty_repo bool: Whether the project is empty.
environments_access_level str: Set the environments access level. Valid values are disabled, private, enabled.
external_authorization_classification_label str: The classification label for the project.
feature_flags_access_level str: Set the feature flags access level. Valid values are disabled, private, enabled.
forking_access_level str: Set the forking access level. Valid values are disabled, private, enabled.
http_url_to_repo str: URL that can be provided to git clone to clone the
id str: The integer that uniquely identifies the project within the gitlab install.
import_url str: URL the project was imported from.
infrastructure_access_level str: Set the infrastructure access level. Valid values are disabled, private, enabled.
issues_access_level str: Set the issues access level. Valid values are disabled, private, enabled.
issues_enabled bool: Enable issue tracking for the project.
keep_latest_artifact bool: Disable or enable the ability to keep the latest artifact for this project.
lfs_enabled bool: Enable LFS for the project.
merge_commit_template str: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
merge_pipelines_enabled bool: Enable or disable merge pipelines.
merge_requests_access_level str: Set the merge requests access level. Valid values are disabled, private, enabled.
merge_requests_enabled bool: Enable merge requests for the project.
merge_trains_enabled bool: Enable or disable merge trains.
monitor_access_level str: Set the monitor access level. Valid values are disabled, private, enabled.
name str: The name of the project.
namespace_id int: The namespace (group or user) of the project. Defaults to your user.
path str: The path of the repository.
path_with_namespace str: The path of the repository with namespace.
pipelines_enabled bool: Enable pipelines for the project.
printing_merge_request_link_enabled bool: Show link to create/view merge request when pushing from the command line
push_rules Sequence[GetProjectPushRule]: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
releases_access_level str: Set the releases access level. Valid values are disabled, private, enabled.
remove_source_branch_after_merge bool: Enable Delete source branch option by default for all new merge requests
repository_access_level str: Set the repository access level. Valid values are disabled, private, enabled.
repository_storage str: Which storage shard the repository is on. (administrator only)
request_access_enabled bool: Allow users to request member access.
requirements_access_level str: Set the requirements access level. Valid values are disabled, private, enabled.
resolve_outdated_diff_discussions bool: Automatically resolve merge request diffs discussions on lines changed with a push.
restrict_user_defined_variables bool: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
runners_token str: Registration token to use during runner setup.
security_and_compliance_access_level str: Set the security and compliance access level. Valid values are disabled, private, enabled.
shared_with_groups Sequence[GetProjectSharedWithGroup]: Describes groups which have access shared to this project.
snippets_access_level str: Set the snippets access level. Valid values are disabled, private, enabled.
snippets_enabled bool: Enable snippets for the project.
squash_commit_template str: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
ssh_url_to_repo str: URL that can be provided to git clone to clone the
suggestion_commit_message str: The commit message used to apply merge request suggestions.
topics Sequence[str]: The list of topics for the project.
visibility_level str: Repositories are created as private by default.
web_url str: URL that can be used to find the project in a browser.
wiki_access_level str: Set the wiki access level. Valid values are disabled, private, enabled.
wiki_enabled bool: Enable wiki for the project.
public_builds bool: If true, jobs can be viewed by non-project members.

analyticsAccessLevel String: Set the analytics access level. Valid values are disabled, private, enabled.
archived Boolean: Whether the project is in read-only mode (archived).
autoCancelPendingPipelines String: Auto-cancel pending pipelines. This isn’t a boolean, but enabled/disabled.
autoDevopsDeployStrategy String: Auto Deploy strategy. Valid values are continuous, manual, timed_incremental.
autoDevopsEnabled Boolean: Enable Auto DevOps for this project.
autocloseReferencedIssues Boolean: Set whether auto-closing referenced issues on default branch.
buildGitStrategy String: The Git strategy. Defaults to fetch.
buildTimeout Number: The maximum amount of time, in seconds, that a job can run.
buildsAccessLevel String: Set the builds access level. Valid values are disabled, private, enabled.
ciConfigPath String: CI config file path for the project.
ciDefaultGitDepth Number: Default number of revisions for shallow cloning.
ciRestrictPipelineCancellationRole String: The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are developer, maintainer, no one
ciSeparatedCaches Boolean: Use separate caches for protected branches.
containerExpirationPolicies List<Property Map>: Set the image cleanup policy for this project. Note: this field is sometimes named container_expiration_policy_attributes in the GitLab Upstream API.
containerRegistryAccessLevel String: Set visibility of container registry, for this project. Valid values are disabled, private, enabled.
defaultBranch String: The default branch for the project.
description String: A description of the project.
emailsEnabled Boolean: Enable email notifications.
emptyRepo Boolean: Whether the project is empty.
environmentsAccessLevel String: Set the environments access level. Valid values are disabled, private, enabled.
externalAuthorizationClassificationLabel String: The classification label for the project.
featureFlagsAccessLevel String: Set the feature flags access level. Valid values are disabled, private, enabled.
forkingAccessLevel String: Set the forking access level. Valid values are disabled, private, enabled.
httpUrlToRepo String: URL that can be provided to git clone to clone the
id String: The integer that uniquely identifies the project within the gitlab install.
importUrl String: URL the project was imported from.
infrastructureAccessLevel String: Set the infrastructure access level. Valid values are disabled, private, enabled.
issuesAccessLevel String: Set the issues access level. Valid values are disabled, private, enabled.
issuesEnabled Boolean: Enable issue tracking for the project.
keepLatestArtifact Boolean: Disable or enable the ability to keep the latest artifact for this project.
lfsEnabled Boolean: Enable LFS for the project.
mergeCommitTemplate String: Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.)
mergePipelinesEnabled Boolean: Enable or disable merge pipelines.
mergeRequestsAccessLevel String: Set the merge requests access level. Valid values are disabled, private, enabled.
mergeRequestsEnabled Boolean: Enable merge requests for the project.
mergeTrainsEnabled Boolean: Enable or disable merge trains.
monitorAccessLevel String: Set the monitor access level. Valid values are disabled, private, enabled.
name String: The name of the project.
namespaceId Number: The namespace (group or user) of the project. Defaults to your user.
path String: The path of the repository.
pathWithNamespace String: The path of the repository with namespace.
pipelinesEnabled Boolean: Enable pipelines for the project.
printingMergeRequestLinkEnabled Boolean: Show link to create/view merge request when pushing from the command line
pushRules List<Property Map>: Push rules for the project. Push rules are only available on Enterprise plans and if the authenticated has permissions to read them.
releasesAccessLevel String: Set the releases access level. Valid values are disabled, private, enabled.
removeSourceBranchAfterMerge Boolean: Enable Delete source branch option by default for all new merge requests
repositoryAccessLevel String: Set the repository access level. Valid values are disabled, private, enabled.
repositoryStorage String: Which storage shard the repository is on. (administrator only)
requestAccessEnabled Boolean: Allow users to request member access.
requirementsAccessLevel String: Set the requirements access level. Valid values are disabled, private, enabled.
resolveOutdatedDiffDiscussions Boolean: Automatically resolve merge request diffs discussions on lines changed with a push.
restrictUserDefinedVariables Boolean: Allow only users with the Maintainer role to pass user-defined variables when triggering a pipeline.
runnersToken String: Registration token to use during runner setup.
securityAndComplianceAccessLevel String: Set the security and compliance access level. Valid values are disabled, private, enabled.
sharedWithGroups List<Property Map>: Describes groups which have access shared to this project.
snippetsAccessLevel String: Set the snippets access level. Valid values are disabled, private, enabled.
snippetsEnabled Boolean: Enable snippets for the project.
squashCommitTemplate String: Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.)
sshUrlToRepo String: URL that can be provided to git clone to clone the
suggestionCommitMessage String: The commit message used to apply merge request suggestions.
topics List<String>: The list of topics for the project.
visibilityLevel String: Repositories are created as private by default.
webUrl String: URL that can be used to find the project in a browser.
wikiAccessLevel String: Set the wiki access level. Valid values are disabled, private, enabled.
wikiEnabled Boolean: Enable wiki for the project.
publicBuilds Boolean: If true, jobs can be viewed by non-project members.

Supporting Types

GetProjectContainerExpirationPolicy

Cadence string: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
Enabled bool: If true, the policy is enabled.
KeepN int: The number of images to keep.
NameRegex string: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
NameRegexDelete string: The regular expression to match image names to delete.
NameRegexKeep string: The regular expression to match image names to keep.
NextRunAt string: The next time the policy will run.
OlderThan string: The number of days to keep images.

Cadence string: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
Enabled bool: If true, the policy is enabled.
KeepN int: The number of images to keep.
NameRegex string: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
NameRegexDelete string: The regular expression to match image names to delete.
NameRegexKeep string: The regular expression to match image names to keep.
NextRunAt string: The next time the policy will run.
OlderThan string: The number of days to keep images.

cadence String: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
enabled Boolean: If true, the policy is enabled.
keepN Integer: The number of images to keep.
nameRegex String: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
nameRegexDelete String: The regular expression to match image names to delete.
nameRegexKeep String: The regular expression to match image names to keep.
nextRunAt String: The next time the policy will run.
olderThan String: The number of days to keep images.

cadence string: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
enabled boolean: If true, the policy is enabled.
keepN number: The number of images to keep.
nameRegex string: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
nameRegexDelete string: The regular expression to match image names to delete.
nameRegexKeep string: The regular expression to match image names to keep.
nextRunAt string: The next time the policy will run.
olderThan string: The number of days to keep images.

cadence str: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
enabled bool: If true, the policy is enabled.
keep_n int: The number of images to keep.
name_regex str: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
name_regex_delete str: The regular expression to match image names to delete.
name_regex_keep str: The regular expression to match image names to keep.
next_run_at str: The next time the policy will run.
older_than str: The number of days to keep images.

cadence String: The cadence of the policy. Valid values are: 1d, 7d, 14d, 1month, 3month.
enabled Boolean: If true, the policy is enabled.
keepN Number: The number of images to keep.
nameRegex String: The regular expression to match image names to delete.
Deprecated: name_regex has been deprecated. Use name_regex_delete instead.
nameRegexDelete String: The regular expression to match image names to delete.
nameRegexKeep String: The regular expression to match image names to keep.
nextRunAt String: The next time the policy will run.
olderThan String: The number of days to keep images.

GetProjectPushRule

AuthorEmailRegex string: All commit author emails must match this regex, e.g. @my-company.com$.
BranchNameRegex string: All branch names must match this regex, e.g. (feature|hotfix)\/*.
CommitCommitterCheck bool: Users can only push commits to this repository that were committed with one of their own verified emails.
CommitCommitterNameCheck bool: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
CommitMessageNegativeRegex string: No commit message is allowed to match this regex, for example ssh\:\/\/.
CommitMessageRegex string: All commit messages must match this regex, e.g. Fixed \d+\..*.
DenyDeleteTag bool: Deny deleting a tag.
FileNameRegex string: All committed filenames must not match this regex, e.g. (jar|exe)$.
MaxFileSize int: Maximum file size (MB).
MemberCheck bool: Restrict commits by author (email) to existing GitLab users.
PreventSecrets bool: GitLab will reject any files that are likely to contain secrets.
RejectUnsignedCommits bool: Reject commit when it’s not signed through GPG.

AuthorEmailRegex string: All commit author emails must match this regex, e.g. @my-company.com$.
BranchNameRegex string: All branch names must match this regex, e.g. (feature|hotfix)\/*.
CommitCommitterCheck bool: Users can only push commits to this repository that were committed with one of their own verified emails.
CommitCommitterNameCheck bool: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
CommitMessageNegativeRegex string: No commit message is allowed to match this regex, for example ssh\:\/\/.
CommitMessageRegex string: All commit messages must match this regex, e.g. Fixed \d+\..*.
DenyDeleteTag bool: Deny deleting a tag.
FileNameRegex string: All committed filenames must not match this regex, e.g. (jar|exe)$.
MaxFileSize int: Maximum file size (MB).
MemberCheck bool: Restrict commits by author (email) to existing GitLab users.
PreventSecrets bool: GitLab will reject any files that are likely to contain secrets.
RejectUnsignedCommits bool: Reject commit when it’s not signed through GPG.

authorEmailRegex String: All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex String: All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck Boolean: Users can only push commits to this repository that were committed with one of their own verified emails.
commitCommitterNameCheck Boolean: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex String: No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex String: All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag Boolean: Deny deleting a tag.
fileNameRegex String: All committed filenames must not match this regex, e.g. (jar|exe)$.
maxFileSize Integer: Maximum file size (MB).
memberCheck Boolean: Restrict commits by author (email) to existing GitLab users.
preventSecrets Boolean: GitLab will reject any files that are likely to contain secrets.
rejectUnsignedCommits Boolean: Reject commit when it’s not signed through GPG.

authorEmailRegex string: All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex string: All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck boolean: Users can only push commits to this repository that were committed with one of their own verified emails.
commitCommitterNameCheck boolean: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex string: No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex string: All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag boolean: Deny deleting a tag.
fileNameRegex string: All committed filenames must not match this regex, e.g. (jar|exe)$.
maxFileSize number: Maximum file size (MB).
memberCheck boolean: Restrict commits by author (email) to existing GitLab users.
preventSecrets boolean: GitLab will reject any files that are likely to contain secrets.
rejectUnsignedCommits boolean: Reject commit when it’s not signed through GPG.

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 bool: Users can only push commits to this repository that were committed with one of their own verified emails.
commit_committer_name_check bool: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
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 bool: Deny deleting a tag.
file_name_regex str: All committed filenames must not match this regex, e.g. (jar|exe)$.
max_file_size int: Maximum file size (MB).
member_check bool: Restrict commits by author (email) to existing GitLab users.
prevent_secrets bool: GitLab will reject any files that are likely to contain secrets.
reject_unsigned_commits bool: Reject commit when it’s not signed through GPG.

authorEmailRegex String: All commit author emails must match this regex, e.g. @my-company.com$.
branchNameRegex String: All branch names must match this regex, e.g. (feature|hotfix)\/*.
commitCommitterCheck Boolean: Users can only push commits to this repository that were committed with one of their own verified emails.
commitCommitterNameCheck Boolean: Users can only push commits to this repository if the commit author name is consistent with their GitLab account name.
commitMessageNegativeRegex String: No commit message is allowed to match this regex, for example ssh\:\/\/.
commitMessageRegex String: All commit messages must match this regex, e.g. Fixed \d+\..*.
denyDeleteTag Boolean: Deny deleting a tag.
fileNameRegex String: All committed filenames must not match this regex, e.g. (jar|exe)$.
maxFileSize Number: Maximum file size (MB).
memberCheck Boolean: Restrict commits by author (email) to existing GitLab users.
preventSecrets Boolean: GitLab will reject any files that are likely to contain secrets.
rejectUnsignedCommits Boolean: Reject commit when it’s not signed through GPG.

GetProjectSharedWithGroup

GroupAccessLevel int: The access_level permission level of the shared group.
GroupFullPath string: The full path of the group shared with.
GroupId int: The ID of the group shared with.
GroupName string: The name of the group shared with.

GroupAccessLevel int: The access_level permission level of the shared group.
GroupFullPath string: The full path of the group shared with.
GroupId int: The ID of the group shared with.
GroupName string: The name of the group shared with.

groupAccessLevel Integer: The access_level permission level of the shared group.
groupFullPath String: The full path of the group shared with.
groupId Integer: The ID of the group shared with.
groupName String: The name of the group shared with.

groupAccessLevel number: The access_level permission level of the shared group.
groupFullPath string: The full path of the group shared with.
groupId number: The ID of the group shared with.
groupName string: The name of the group shared with.

group_access_level int: The access_level permission level of the shared group.
group_full_path str: The full path of the group shared with.
group_id int: The ID of the group shared with.
group_name str: The name of the group shared with.

groupAccessLevel Number: The access_level permission level of the shared group.
groupFullPath String: The full path of the group shared with.
groupId Number: The ID of the group shared with.
groupName String: The name of the group shared with.

Package Details

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

GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi

pulumi/pulumi-gitlab

gitlab.getProject

On this page

On this page

Using getProject

getProject Result

Supporting Types

GetProjectContainerExpirationPolicy

GetProjectPushRule

GetProjectSharedWithGroup

Package Details

On this page

On this page