Provider

GitHub v6.15.0, Aug 14 26

Viewing docs for GitHub v6.15.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

Viewing docs for GitHub v6.15.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

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.

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,
             app_auth: Optional[ProviderAppAuthArgs] = None,
             base_url: Optional[str] = None,
             cache_path: Optional[str] = None,
             insecure: Optional[bool] = None,
             legacy_client: Optional[bool] = None,
             max_per_page: Optional[int] = None,
             max_retries: Optional[int] = None,
             organization: Optional[str] = None,
             owner: Optional[str] = None,
             parallel_requests: Optional[bool] = None,
             read_delay_ms: Optional[int] = None,
             retry_delay_ms: Optional[int] = None,
             retryable_errors: Optional[Sequence[int]] = None,
             token: Optional[str] = None,
             write_delay_ms: Optional[int] = 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:github
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "pulumi_providers_github" "name" {
    # resource properties
}

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:

AppAuth ProviderAppAuth: Authenticate using a GitHub App.
BaseUrl string: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
CachePath string: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
Insecure bool: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
LegacyClient bool: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
MaxPerPage int: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
MaxRetries int: The maximum number of retries for failed requests; this defaults to 3.
Organization string: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
Owner string: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
ParallelRequests bool: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
ReadDelayMs int: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
RetryDelayMs int: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
RetryableErrors List<int>: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
Token string: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
WriteDelayMs int: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

AppAuth ProviderAppAuthArgs: Authenticate using a GitHub App.
BaseUrl string: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
CachePath string: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
Insecure bool: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
LegacyClient bool: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
MaxPerPage int: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
MaxRetries int: The maximum number of retries for failed requests; this defaults to 3.
Organization string: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
Owner string: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
ParallelRequests bool: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
ReadDelayMs int: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
RetryDelayMs int: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
RetryableErrors []int: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
Token string: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
WriteDelayMs int: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

app_auth object: Authenticate using a GitHub App.
base_url string: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
cache_path string: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
insecure bool: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
legacy_client bool: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
max_per_page number: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
max_retries number: The maximum number of retries for failed requests; this defaults to 3.
organization string: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
owner string: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
parallel_requests bool: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
read_delay_ms number: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
retry_delay_ms number: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
retryable_errors list(number): List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
token string: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
write_delay_ms number: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

appAuth ProviderAppAuth: Authenticate using a GitHub App.
baseUrl String: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
cachePath String: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
insecure Boolean: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
legacyClient Boolean: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
maxPerPage Integer: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
maxRetries Integer: The maximum number of retries for failed requests; this defaults to 3.
organization String: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
owner String: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
parallelRequests Boolean: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
readDelayMs Integer: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
retryDelayMs Integer: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
retryableErrors List<Integer>: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
token String: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
writeDelayMs Integer: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

appAuth ProviderAppAuth: Authenticate using a GitHub App.
baseUrl string: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
cachePath string: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
insecure boolean: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
legacyClient boolean: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
maxPerPage number: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
maxRetries number: The maximum number of retries for failed requests; this defaults to 3.
organization string: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
owner string: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
parallelRequests boolean: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
readDelayMs number: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
retryDelayMs number: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
retryableErrors number[]: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
token string: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
writeDelayMs number: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

app_auth ProviderAppAuthArgs: Authenticate using a GitHub App.
base_url str: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
cache_path str: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
insecure bool: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
legacy_client bool: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
max_per_page int: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
max_retries int: The maximum number of retries for failed requests; this defaults to 3.
organization str: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
owner str: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
parallel_requests bool: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
read_delay_ms int: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
retry_delay_ms int: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
retryable_errors Sequence[int]: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
token str: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
write_delay_ms int: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

appAuth Property Map: Authenticate using a GitHub App.
baseUrl String: The base URL for the GitHub API; this defaults to the GitHub API URL. If you are using GitHub Enterprise Server (GHES) or GitHub Enterprise Cloud with Data Residency (GHEC-DR), this is required. This can also be set by the GITHUB_BASE_URL environment variable. It can also be sourced from the following environment variable: GITHUB_BASE_URL
cachePath String: The path to the cache directory for persisting GitHub API requests between runs; if not set there will be no caching between runs. This can also be set by the GITHUB_CACHE_PATH environment variable.
insecure Boolean: Allow insecure server connections when using SSL.
Deprecated: This argument is deprecated as it's currently not used and will be removed in the next major version.
legacyClient Boolean: Use the legacy GitHub client implementation; if set to false, the new client implementation is used. This can also be set by the GITHUB_LEGACY_CLIENT environment variable.
maxPerPage Number: The maximum number of results per page for paginated API requests; this defaults to 100. This can also be set by the GITHUB_MAX_PER_PAGE environment variable.
maxRetries Number: The maximum number of retries for failed requests; this defaults to 3.
organization String: GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
Deprecated: This argument is deprecated and will be removed in a future major release; use owner instead.
owner String: GitHub organization or user account to manage; this is required when authenticating using a GitHub App. If the owner is not provided and a token is provided, the provider will attempt to auto-detect the owner associated with the token. This can also be set by the GITHUB_OWNER environment variable.
parallelRequests Boolean: Allow the provider to make parallel API calls; this is experimental and may cause concurrency and rate limiting issues. This is ignored for the REST API when legacyClient is false since the new client implementation is designed to safely handle parallel requests.
readDelayMs Number: The delay in milliseconds between read operations; this defaults to 0. This can be used to mitigate rate limiting issues when performing a large number of read operations. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.
retryDelayMs Number: The delay in milliseconds between retry attempts; this defaults to 1000. This setting only applies when maxRetries is greater than 0.
retryableErrors List<Number>: List of HTTP status codes that should be retried; if not set this uses the provider defaults. This setting only applies when maxRetries is greater than 0. This is ignored for the REST API when legacyClient is false since the new client implementation handles the retry logic.
token String: GitHub OAuth or Personal Access Token (PAT) to use for authentication. This can also be set by the GITHUB_TOKEN environment variable. It can also be sourced from the following environment variable: GITHUB_TOKEN
writeDelayMs Number: The delay in milliseconds between write operations; this defaults to 1000. This is used to mitigate the GitHub API's abuse rate limits when writing. Note that ALL requests to the GraphQL API are implemented as POST requests under the hood, so this setting affects those calls as well. This is ignored for the REST API when legacyClient is false since the new client implementation is GitHub rate limit aware.

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 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(any)

result Map<String,Object>

result {[key: string]: any}

result Mapping[str, Any]

result Map<Any>

Supporting Types

ProviderAppAuth, ProviderAppAuthArgs

Id string: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
InstallationId string: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
PemFile string: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

Id string: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
InstallationId string: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
PemFile string: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

id string: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installation_id string: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pem_file string: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

id String: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installationId String: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pemFile String: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

id string: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installationId string: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pemFile string: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

id str: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installation_id str: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pem_file str: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

id String: The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installationId String: The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pemFile String: The GitHub App's PEM file content; \n can be used for newlines. This can also be set by the GITHUB_APP_PEM_FILE environment variable.

Package Details

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

Viewing docs for GitHub v6.15.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-github

github.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

Supporting Types

ProviderAppAuth, ProviderAppAuthArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

github.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

Supporting Types

ProviderAppAuth, ProviderAppAuthArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.