ProviderArgs

data class ProviderArgs(val baseUrl: Output<String>? = null, val cacertFile: Output<String>? = null, val clientCert: Output<String>? = null, val clientKey: Output<String>? = null, val earlyAuthCheck: Output<Boolean>? = null, val headers: Output<Map<String, String>>? = null, val insecure: Output<Boolean>? = null, val retries: Output<Int>? = null, val token: Output<String>? = null) : ConvertibleToJava<ProviderArgs>

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.

Constructors

Link copied to clipboard
constructor(baseUrl: Output<String>? = null, cacertFile: Output<String>? = null, clientCert: Output<String>? = null, clientKey: Output<String>? = null, earlyAuthCheck: Output<Boolean>? = null, headers: Output<Map<String, String>>? = null, insecure: Output<Boolean>? = null, retries: Output<Int>? = null, token: Output<String>? = null)

Properties

Link copied to clipboard
val baseUrl: Output<String>? = null

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.

Link copied to clipboard
val cacertFile: Output<String>? = null

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.

Link copied to clipboard
val clientCert: Output<String>? = null

File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.

Link copied to clipboard
val clientKey: Output<String>? = null

File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when client_cert is set.

Link copied to clipboard
val earlyAuthCheck: Output<Boolean>? = null
Link copied to clipboard
val headers: Output<Map<String, String>>? = null

A map of headers to append to all API request to the GitLab instance.

Link copied to clipboard
val insecure: Output<Boolean>? = null

When set to true this disables SSL verification of the connection to the GitLab instance.

Link copied to clipboard
val retries: Output<Int>? = null

The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.

Link copied to clipboard
val token: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): ProviderArgs