GitLab v9.3.0, Sep 29 25

GitLab v9.3.0 published on Monday, Sep 29, 2025 by Pulumi

gitlab.Provider

GitLab v9.3.0 published on Monday, Sep 29, 2025 by Pulumi

The provider type for the gitlab package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             base_url: Optional[str] = None,
             cacert_file: Optional[str] = None,
             client_cert: Optional[str] = None,
             client_key: Optional[str] = None,
             config_file: Optional[str] = None,
             context: Optional[str] = None,
             early_auth_check: Optional[bool] = None,
             enable_auto_ci_support: Optional[bool] = None,
             headers: Optional[Mapping[str, str]] = None,
             insecure: Optional[bool] = None,
             retries: Optional[int] = None,
             token: Optional[str] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:gitlab
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Provider resource accepts the following input properties:

BaseUrl string: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
CacertFile string: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
ClientCert string: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
ClientKey string: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
ConfigFile string: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
Context string: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
EarlyAuthCheck bool
EnableAutoCiSupport bool: If automatic CI support should be enabled or not. This only works when not providing a token.
Headers Dictionary<string, string>: A map of headers to append to all API request to the GitLab instance.
Insecure bool: When set to true this disables SSL verification of the connection to the GitLab instance.
Retries int: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
Token string: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

BaseUrl string: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
CacertFile string: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
ClientCert string: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
ClientKey string: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
ConfigFile string: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
Context string: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
EarlyAuthCheck bool
EnableAutoCiSupport bool: If automatic CI support should be enabled or not. This only works when not providing a token.
Headers map[string]string: A map of headers to append to all API request to the GitLab instance.
Insecure bool: When set to true this disables SSL verification of the connection to the GitLab instance.
Retries int: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
Token string: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

baseUrl String: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
cacertFile String: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
clientCert String: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
clientKey String: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
configFile String: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
context String: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
earlyAuthCheck Boolean
enableAutoCiSupport Boolean: If automatic CI support should be enabled or not. This only works when not providing a token.
headers Map<String,String>: A map of headers to append to all API request to the GitLab instance.
insecure Boolean: When set to true this disables SSL verification of the connection to the GitLab instance.
retries Integer: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
token String: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

baseUrl string: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
cacertFile string: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
clientCert string: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
clientKey string: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
configFile string: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
context string: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
earlyAuthCheck boolean
enableAutoCiSupport boolean: If automatic CI support should be enabled or not. This only works when not providing a token.
headers {[key: string]: string}: A map of headers to append to all API request to the GitLab instance.
insecure boolean: When set to true this disables SSL verification of the connection to the GitLab instance.
retries number: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
token string: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

base_url str: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
cacert_file str: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
client_cert str: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
client_key str: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
config_file str: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
context str: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
early_auth_check bool
enable_auto_ci_support bool: If automatic CI support should be enabled or not. This only works when not providing a token.
headers Mapping[str, str]: A map of headers to append to all API request to the GitLab instance.
insecure bool: When set to true this disables SSL verification of the connection to the GitLab instance.
retries int: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
token str: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

baseUrl String: This is the target GitLab base API endpoint. Providing a value is a requirement when working with GitLab CE or GitLab Enterprise e.g. https://my.gitlab.server/api/v4/. It is optional to provide this value and it can also be sourced from the GITLAB_BASE_URL environment variable. The value must end with a slash.
cacertFile String: This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
clientCert String: File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
clientKey String: File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.
configFile String: The path to the configuration file to use. It may be sourced from the GITLAB_CONFIG_FILE environment variable.
context String: The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the GITLAB_CONTEXT environment variable.
earlyAuthCheck Boolean
enableAutoCiSupport Boolean: If automatic CI support should be enabled or not. This only works when not providing a token.
headers Map<String>: A map of headers to append to all API request to the GitLab instance.
insecure Boolean: When set to true this disables SSL verification of the connection to the GitLab instance.
retries Number: The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
token String: The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the GITLAB_TOKEN environment variable.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Provider Resource Methods

TerraformConfig Method

This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

Using TerraformConfig

terraformConfig(): Output<Provider.TerraformConfigResult>

def terraform_config() -> Output[Provider.Terraform_configResult]

func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)

public Output<Provider.TerraformConfigResult> TerraformConfig()

TerraformConfig Result

Result Dictionary<string, object>

Result map[string]interface{}

result Map<String,Object>

result {[key: string]: any}

result Mapping[str, Any]

result Map<Any>

Package Details

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

GitLab v9.3.0 published on Monday, Sep 29, 2025 by Pulumi

pulumi/pulumi-gitlab

gitlab.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Provider Resource Methods

TerraformConfig Method

Using TerraformConfig

TerraformConfig Result

Package Details

On this page

On this page