config

Documentation

Index

• func GetAppAuth(ctx *pulumi.Context) string
• func GetBaseUrl(ctx *pulumi.Context) string
• func GetInsecure(ctx *pulumi.Context) bool
• func GetMaxRetries(ctx *pulumi.Context) int
• func GetOrganization(ctx *pulumi.Context) string
• func GetOwner(ctx *pulumi.Context) string
• func GetParallelRequests(ctx *pulumi.Context) bool
• func GetReadDelayMs(ctx *pulumi.Context) int
• func GetRetryDelayMs(ctx *pulumi.Context) int
• func GetRetryableErrors(ctx *pulumi.Context) string
• func GetToken(ctx *pulumi.Context) string
• func GetWriteDelayMs(ctx *pulumi.Context) int
• type AppAuth
• type AppAuthArgs
  • func (AppAuthArgs) ElementType() reflect.Type
  • func (i AppAuthArgs) ToAppAuthOutput() AppAuthOutput
  • func (i AppAuthArgs) ToAppAuthOutputWithContext(ctx context.Context) AppAuthOutput
• type AppAuthInput
• type AppAuthOutput
  • func (AppAuthOutput) ElementType() reflect.Type
  • func (o AppAuthOutput) Id() pulumi.StringOutput
  • func (o AppAuthOutput) InstallationId() pulumi.StringOutput
  • func (o AppAuthOutput) PemFile() pulumi.StringOutput
  • func (o AppAuthOutput) ToAppAuthOutput() AppAuthOutput
  • func (o AppAuthOutput) ToAppAuthOutputWithContext(ctx context.Context) AppAuthOutput

Functions

func GetAppAuth

func GetAppAuth(ctx *pulumi.Context) string

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

func GetBaseUrl

func GetBaseUrl(ctx *pulumi.Context) string

The GitHub Base API URL

func GetInsecure

func GetInsecure(ctx *pulumi.Context) bool

Enable `insecure` mode for testing purposes

func GetMaxRetries

func GetMaxRetries(ctx *pulumi.Context) int

Number of times to retry a request after receiving an error status codeDefaults to 3

func GetOrganization

func GetOrganization(ctx *pulumi.Context) 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)

func GetOwner

func GetOwner(ctx *pulumi.Context) string

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

func GetParallelRequests

func GetParallelRequests(ctx *pulumi.Context) 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

func GetReadDelayMs

func GetReadDelayMs(ctx *pulumi.Context) int

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

func GetRetryDelayMs

func GetRetryDelayMs(ctx *pulumi.Context) int

Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. Defaults to 1000ms or 1s if not set, the maxRetries must be set to greater than zero.

func GetRetryableErrors

func GetRetryableErrors(ctx *pulumi.Context) string

Allow the provider to retry after receiving an error status code, the maxRetries should be set for this to workDefaults to [500, 502, 503, 504]

func GetToken

func GetToken(ctx *pulumi.Context) string

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

func GetWriteDelayMs

func GetWriteDelayMs(ctx *pulumi.Context) int

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

Types

type AppAuth

type AppAuth struct {
	// The GitHub App ID.
	Id string `pulumi:"id"`
	// The GitHub App installation instance ID.
	InstallationId string `pulumi:"installationId"`
	// The GitHub App PEM file contents.
	PemFile string `pulumi:"pemFile"`
}

type AppAuthArgs

type AppAuthArgs struct {
	// The GitHub App ID.
	Id pulumi.StringInput `pulumi:"id"`
	// The GitHub App installation instance ID.
	InstallationId pulumi.StringInput `pulumi:"installationId"`
	// The GitHub App PEM file contents.
	PemFile pulumi.StringInput `pulumi:"pemFile"`
}

func (AppAuthArgs) ElementType

func (AppAuthArgs) ElementType() reflect.Type

func (AppAuthArgs) ToAppAuthOutput

func (i AppAuthArgs) ToAppAuthOutput() AppAuthOutput

func (AppAuthArgs) ToAppAuthOutputWithContext

func (i AppAuthArgs) ToAppAuthOutputWithContext(ctx context.Context) AppAuthOutput

type AppAuthInput

type AppAuthInput interface {
	pulumi.Input

	ToAppAuthOutput() AppAuthOutput
	ToAppAuthOutputWithContext(context.Context) AppAuthOutput
}

AppAuthInput is an input type that accepts AppAuthArgs and AppAuthOutput values. You can construct a concrete instance of `AppAuthInput` via:

AppAuthArgs{...}

type AppAuthOutput

type AppAuthOutput struct{ *pulumi.OutputState }

func (AppAuthOutput) ElementType

func (AppAuthOutput) ElementType() reflect.Type

func (AppAuthOutput) Id

func (o AppAuthOutput) Id() pulumi.StringOutput

The GitHub App ID.

func (AppAuthOutput) InstallationId

func (o AppAuthOutput) InstallationId() pulumi.StringOutput

The GitHub App installation instance ID.

func (AppAuthOutput) PemFile

func (o AppAuthOutput) PemFile() pulumi.StringOutput

The GitHub App PEM file contents.

func (AppAuthOutput) ToAppAuthOutput

func (o AppAuthOutput) ToAppAuthOutput() AppAuthOutput

func (AppAuthOutput) ToAppAuthOutputWithContext

func (o AppAuthOutput) ToAppAuthOutputWithContext(ctx context.Context) AppAuthOutput