Docs Packages
  1. Packages
  2. GitHub
  3. API Docs
  4. Provider
GitHub v5.22.0 published on Tuesday, Oct 31, 2023 by Pulumi
pulumi/pulumi-github

github.Provider

Explore with Pulumi AI

github logo
GitHub v5.22.0 published on Tuesday, Oct 31, 2023 by Pulumi
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

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             app_auth: Optional[ProviderAppAuthArgs] = None,
             base_url: Optional[str] = None,
             insecure: Optional[bool] = None,
             organization: Optional[str] = None,
             owner: Optional[str] = None,
             parallel_requests: Optional[bool] = None,
             read_delay_ms: Optional[int] = None,
             token: Optional[str] = None,
             write_delay_ms: Optional[int] = None)
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = 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.
    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

    The Provider resource accepts the following input properties:

    AppAuth ProviderAppAuth

    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.

    BaseUrl string

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    Insecure bool

    Enable insecure mode for testing purposes

    Organization string

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    Owner string

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

    ParallelRequests bool

    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

    ReadDelayMs int

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

    Token string

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

    WriteDelayMs int

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

    AppAuth ProviderAppAuthArgs

    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.

    BaseUrl string

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    Insecure bool

    Enable insecure mode for testing purposes

    Organization string

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    Owner string

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

    ParallelRequests bool

    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

    ReadDelayMs int

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

    Token string

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

    WriteDelayMs int

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

    appAuth ProviderAppAuth

    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.

    baseUrl String

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    insecure Boolean

    Enable insecure mode for testing purposes

    organization String

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    owner String

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

    parallelRequests Boolean

    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

    readDelayMs Integer

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

    token String

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

    writeDelayMs Integer

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

    appAuth ProviderAppAuth

    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.

    baseUrl string

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    insecure boolean

    Enable insecure mode for testing purposes

    organization string

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    owner string

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

    parallelRequests boolean

    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

    readDelayMs number

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

    token string

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

    writeDelayMs number

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

    app_auth ProviderAppAuthArgs

    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.

    base_url str

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    insecure bool

    Enable insecure mode for testing purposes

    organization str

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    owner str

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

    parallel_requests bool

    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

    read_delay_ms int

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

    token str

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

    write_delay_ms int

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

    appAuth Property Map

    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.

    baseUrl String

    The GitHub Base API URL It can also be sourced from the following environment variable: GITHUB_BASE_URL

    insecure Boolean

    Enable insecure mode for testing purposes

    organization String

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

    Deprecated:

    Use owner (or GITHUB_OWNER) instead of organization (or GITHUB_ORGANIZATION)

    owner String

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

    parallelRequests Boolean

    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

    readDelayMs Number

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

    token String

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

    writeDelayMs Number

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

    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.

    Supporting Types

    ProviderAppAuth, ProviderAppAuthArgs

    Id string
    InstallationId string
    PemFile string
    Id string
    InstallationId string
    PemFile string
    id String
    installationId String
    pemFile String
    id string
    installationId string
    pemFile string
    id String
    installationId String
    pemFile String

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the github Terraform Provider.

    github logo
    GitHub v5.22.0 published on Tuesday, Oct 31, 2023 by Pulumi
    pulumi/pulumi-github