Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GithubProvider_IsConstruct ¶
func GithubProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func GithubProvider_TfResourceType ¶
func GithubProvider_TfResourceType() *string
func NewGithubProvider_Override ¶
func NewGithubProvider_Override(g GithubProvider, scope constructs.Construct, id *string, config *GithubProviderConfig)
Create a new {@link https://www.terraform.io/docs/providers/github github} Resource.
Types ¶
type GithubProvider ¶
type GithubProvider interface {
cdktf.TerraformProvider
Alias() *string
SetAlias(val *string)
AliasInput() *string
AppAuth() *GithubProviderAppAuth
SetAppAuth(val *GithubProviderAppAuth)
AppAuthInput() *GithubProviderAppAuth
BaseUrl() *string
SetBaseUrl(val *string)
BaseUrlInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Insecure() interface{}
SetInsecure(val interface{})
InsecureInput() interface{}
// Experimental.
MetaAttributes() *map[string]interface{}
// The tree node.
Node() constructs.Node
Organization() *string
SetOrganization(val *string)
OrganizationInput() *string
Owner() *string
SetOwner(val *string)
OwnerInput() *string
// Experimental.
RawOverrides() interface{}
ReadDelayMs() *float64
SetReadDelayMs(val *float64)
ReadDelayMsInput() *float64
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformProviderSource() *string
// Experimental.
TerraformResourceType() *string
Token() *string
SetToken(val *string)
TokenInput() *string
WriteDelayMs() *float64
SetWriteDelayMs(val *float64)
WriteDelayMsInput() *float64
// Experimental.
AddOverride(path *string, value interface{})
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAlias()
ResetAppAuth()
ResetBaseUrl()
ResetInsecure()
ResetOrganization()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetOwner()
ResetReadDelayMs()
ResetToken()
ResetWriteDelayMs()
SynthesizeAttributes() *map[string]interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://www.terraform.io/docs/providers/github github}.
func NewGithubProvider ¶
func NewGithubProvider(scope constructs.Construct, id *string, config *GithubProviderConfig) GithubProvider
Create a new {@link https://www.terraform.io/docs/providers/github github} Resource.
type GithubProviderAppAuth ¶
type GithubProviderAppAuth struct {
// The GitHub App ID.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#id GithubProvider#id}
//
// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
Id *string `field:"required" json:"id" yaml:"id"`
// The GitHub App installation instance ID.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#installation_id GithubProvider#installation_id}
InstallationId *string `field:"required" json:"installationId" yaml:"installationId"`
// The GitHub App PEM file contents.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#pem_file GithubProvider#pem_file}
PemFile *string `field:"required" json:"pemFile" yaml:"pemFile"`
}
type GithubProviderConfig ¶
type GithubProviderConfig struct {
// Alias name.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#alias GithubProvider#alias}
Alias *string `field:"optional" json:"alias" yaml:"alias"`
// app_auth block.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#app_auth GithubProvider#app_auth}
AppAuth *GithubProviderAppAuth `field:"optional" json:"appAuth" yaml:"appAuth"`
// The GitHub Base API URL.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#base_url GithubProvider#base_url}
BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
// Enable `insecure` mode for testing purposes.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#insecure GithubProvider#insecure}
Insecure interface{} `field:"optional" json:"insecure" yaml:"insecure"`
// The GitHub organization name to manage. Use this field instead of `owner` when managing organization accounts.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#organization GithubProvider#organization}
Organization *string `field:"optional" json:"organization" yaml:"organization"`
// The GitHub owner name to manage. Use this field instead of `organization` when managing individual accounts.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#owner GithubProvider#owner}
Owner *string `field:"optional" json:"owner" yaml:"owner"`
// Amount of time in milliseconds to sleep in between non-write requests to GitHub API.
//
// Defaults to 0ms if not set.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#read_delay_ms GithubProvider#read_delay_ms}
ReadDelayMs *float64 `field:"optional" json:"readDelayMs" yaml:"readDelayMs"`
// The OAuth token used to connect to GitHub.
//
// Anonymous mode is enabled if both `token` and `app_auth` are not set.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#token GithubProvider#token}
Token *string `field:"optional" json:"token" yaml:"token"`
// Amount of time in milliseconds to sleep in between writes to GitHub API.
//
// Defaults to 1000ms or 1s if not set.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github#write_delay_ms GithubProvider#write_delay_ms}
WriteDelayMs *float64 `field:"optional" json:"writeDelayMs" yaml:"writeDelayMs"`
}