ProviderArgs

data class ProviderArgs(val appAuth: Output<ProviderAppAuthArgs>? = null, val baseUrl: Output<String>? = null, val insecure: Output<Boolean>? = null, val organization: Output<String>? = null, val owner: Output<String>? = null, val parallelRequests: Output<Boolean>? = null, val readDelayMs: Output<Int>? = null, val token: Output<String>? = null, val writeDelayMs: Output<Int>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the github 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(appAuth: Output<ProviderAppAuthArgs>? = null, baseUrl: Output<String>? = null, insecure: Output<Boolean>? = null, organization: Output<String>? = null, owner: Output<String>? = null, parallelRequests: Output<Boolean>? = null, readDelayMs: Output<Int>? = null, token: Output<String>? = null, writeDelayMs: Output<Int>? = null)

Properties

Link copied to clipboard
val appAuth: Output<ProviderAppAuthArgs>? = null

The GitHub App credentials used to connect to GitHub. Conflicts with token. Anonymous mode is enabled if both token and app_auth are not set.

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

The GitHub Base API URL

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

Enable insecure mode for testing purposes

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

The GitHub organization name to manage. Use this field instead of owner when managing organization accounts.

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

The GitHub owner name to manage. Use this field instead of organization when managing individual accounts.

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

Allow the provider to make parallel API calls to GitHub. You may want to set it to true when you have a private Github Enterprise without strict rate limits. Although, it is not possible to enable this setting on github.com because we enforce the respect of github.com's best practices to avoid hitting abuse rate limitsDefaults to false if not set

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

Amount of time in milliseconds to sleep in between non-write requests to GitHub API. Defaults to 0ms if not set.

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

The OAuth token used to connect to GitHub. Anonymous mode is enabled if both token and app_auth are not set.

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

Amount of time in milliseconds to sleep in between writes to GitHub API. Defaults to 1000ms or 1s if not set.

Functions

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