Skip to content

Latest commit

 

History

History
1048 lines (658 loc) · 39.1 KB

provider.csharp.md

File metadata and controls

1048 lines (658 loc) · 39.1 KB

provider Submodule

Constructs

GithubProvider

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs github}.

Initializers 

using HashiCorp.Cdktf.Providers.Github;

new GithubProvider(Construct Scope, string Id, GithubProviderConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config GithubProviderConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigOptional

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
ResetAlias No description.
ResetAppAuth No description.
ResetBaseUrl No description.
ResetInsecure No description.
ResetMaxRetries No description.
ResetOrganization No description.
ResetOwner No description.
ResetParallelRequests No description.
ResetReadDelayMs No description.
ResetRetryableErrors No description.
ResetRetryDelayMs No description.
ResetToken No description.
ResetWriteDelayMs No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

ResetAlias 
private void ResetAlias()
ResetAppAuth 
private void ResetAppAuth()
ResetBaseUrl 
private void ResetBaseUrl()
ResetInsecure 
private void ResetInsecure()
ResetMaxRetries 
private void ResetMaxRetries()
ResetOrganization 
private void ResetOrganization()
ResetOwner 
private void ResetOwner()
ResetParallelRequests 
private void ResetParallelRequests()
ResetReadDelayMs 
private void ResetReadDelayMs()
ResetRetryableErrors 
private void ResetRetryableErrors()
ResetRetryDelayMs 
private void ResetRetryDelayMs()
ResetToken 
private void ResetToken()
ResetWriteDelayMs 
private void ResetWriteDelayMs()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformProvider No description.
GenerateConfigForImport Generates CDKTF code for importing a GithubProvider resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Github;

GithubProvider.IsConstruct(object X);

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.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Github;

GithubProvider.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformProvider 
using HashiCorp.Cdktf.Providers.Github;

GithubProvider.IsTerraformProvider(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Github;

GithubProvider.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a GithubProvider resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the GithubProvider to import.

ImportFromIdRequired
  • Type: string

The id of the existing GithubProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the GithubProvider to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AliasInput string No description.
AppAuthInput GithubProviderAppAuth No description.
BaseUrlInput string No description.
InsecureInput object No description.
MaxRetriesInput double No description.
OrganizationInput string No description.
OwnerInput string No description.
ParallelRequestsInput object No description.
ReadDelayMsInput double No description.
RetryableErrorsInput double[] No description.
RetryDelayMsInput double No description.
TokenInput string No description.
WriteDelayMsInput double No description.
AppAuth GithubProviderAppAuth No description.
BaseUrl string No description.
Insecure object No description.
MaxRetries double No description.
Organization string No description.
Owner string No description.
ParallelRequests object No description.
ReadDelayMs double No description.
RetryableErrors double[] No description.
RetryDelayMs double No description.
Token string No description.
WriteDelayMs double No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
AppAuthInputOptional 
public GithubProviderAppAuth AppAuthInput { get; }
BaseUrlInputOptional 
public string BaseUrlInput { get; }
  • Type: string
InsecureInputOptional 
public object InsecureInput { get; }
  • Type: object
MaxRetriesInputOptional 
public double MaxRetriesInput { get; }
  • Type: double
OrganizationInputOptional 
public string OrganizationInput { get; }
  • Type: string
OwnerInputOptional 
public string OwnerInput { get; }
  • Type: string
ParallelRequestsInputOptional 
public object ParallelRequestsInput { get; }
  • Type: object
ReadDelayMsInputOptional 
public double ReadDelayMsInput { get; }
  • Type: double
RetryableErrorsInputOptional 
public double[] RetryableErrorsInput { get; }
  • Type: double[]
RetryDelayMsInputOptional 
public double RetryDelayMsInput { get; }
  • Type: double
TokenInputOptional 
public string TokenInput { get; }
  • Type: string
WriteDelayMsInputOptional 
public double WriteDelayMsInput { get; }
  • Type: double
AppAuthOptional 
public GithubProviderAppAuth AppAuth { get; }
BaseUrlOptional 
public string BaseUrl { get; }
  • Type: string
InsecureOptional 
public object Insecure { get; }
  • Type: object
MaxRetriesOptional 
public double MaxRetries { get; }
  • Type: double
OrganizationOptional 
public string Organization { get; }
  • Type: string
OwnerOptional 
public string Owner { get; }
  • Type: string
ParallelRequestsOptional 
public object ParallelRequests { get; }
  • Type: object
ReadDelayMsOptional 
public double ReadDelayMs { get; }
  • Type: double
RetryableErrorsOptional 
public double[] RetryableErrors { get; }
  • Type: double[]
RetryDelayMsOptional 
public double RetryDelayMs { get; }
  • Type: double
TokenOptional 
public string Token { get; }
  • Type: string
WriteDelayMsOptional 
public double WriteDelayMs { get; }
  • Type: double

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

GithubProviderAppAuth

Initializer 

using HashiCorp.Cdktf.Providers.Github;

new GithubProviderAppAuth {
    string Id,
    string InstallationId,
    string PemFile
};

Properties

Name Type Description
Id string The GitHub App ID.
InstallationId string The GitHub App installation instance ID.
PemFile string The GitHub App PEM file contents.
IdRequired 
public string Id { get; set; }
  • Type: string

The GitHub App ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#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.

InstallationIdRequired 
public string InstallationId { get; set; }
  • Type: string

The GitHub App installation instance ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#installation_id GithubProvider#installation_id}

PemFileRequired 
public string PemFile { get; set; }
  • Type: string

The GitHub App PEM file contents.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#pem_file GithubProvider#pem_file}

GithubProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Github;

new GithubProviderConfig {
    string Alias = null,
    GithubProviderAppAuth AppAuth = null,
    string BaseUrl = null,
    object Insecure = null,
    double MaxRetries = null,
    string Organization = null,
    string Owner = null,
    object ParallelRequests = null,
    double ReadDelayMs = null,
    double[] RetryableErrors = null,
    double RetryDelayMs = null,
    string Token = null,
    double WriteDelayMs = null
};

Properties

Name Type Description
Alias string Alias name.
AppAuth GithubProviderAppAuth app_auth block.
BaseUrl string The GitHub Base API URL.
Insecure object Enable insecure mode for testing purposes.
MaxRetries double Number of times to retry a request after receiving an error status codeDefaults to 3.
Organization string The GitHub organization name to manage. Use this field instead of owner when managing organization accounts.
Owner string The GitHub owner name to manage. Use this field instead of organization when managing individual accounts.
ParallelRequests object Allow the provider to make parallel API calls to GitHub.
ReadDelayMs double Amount of time in milliseconds to sleep in between non-write requests to GitHub API.
RetryableErrors double[] Allow the provider to retry after receiving an error status code, the max_retries should be set for this to workDefaults to [500, 502, 503, 504].
RetryDelayMs double Amount of time in milliseconds to sleep in between requests to GitHub API after an error response.
Token string The OAuth token used to connect to GitHub.
WriteDelayMs double Amount of time in milliseconds to sleep in between writes to GitHub API.
AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#alias GithubProvider#alias}

AppAuthOptional 
public GithubProviderAppAuth AppAuth { get; set; }

app_auth block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#app_auth GithubProvider#app_auth}

BaseUrlOptional 
public string BaseUrl { get; set; }
  • Type: string

The GitHub Base API URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#base_url GithubProvider#base_url}

InsecureOptional 
public object Insecure { get; set; }
  • Type: object

Enable insecure mode for testing purposes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#insecure GithubProvider#insecure}

MaxRetriesOptional 
public double MaxRetries { get; set; }
  • Type: double

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#max_retries GithubProvider#max_retries}

OrganizationOptional 
public string Organization { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#organization GithubProvider#organization}

OwnerOptional 
public string Owner { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#owner GithubProvider#owner}

ParallelRequestsOptional 
public object ParallelRequests { get; set; }
  • Type: object

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#parallel_requests GithubProvider#parallel_requests}

ReadDelayMsOptional 
public double ReadDelayMs { get; set; }
  • Type: double

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://registry.terraform.io/providers/integrations/github/6.5.0/docs#read_delay_ms GithubProvider#read_delay_ms}

RetryableErrorsOptional 
public double[] RetryableErrors { get; set; }
  • Type: double[]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#retryable_errors GithubProvider#retryable_errors}

RetryDelayMsOptional 
public double RetryDelayMs { get; set; }
  • Type: double

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 max_retries must be set to greater than zero.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs#retry_delay_ms GithubProvider#retry_delay_ms}

TokenOptional 
public string Token { get; set; }
  • Type: string

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://registry.terraform.io/providers/integrations/github/6.5.0/docs#token GithubProvider#token}

WriteDelayMsOptional 
public double WriteDelayMs { get; set; }
  • Type: double

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://registry.terraform.io/providers/integrations/github/6.5.0/docs#write_delay_ms GithubProvider#write_delay_ms}