`provider` Submodule

Constructs

GithubProvider

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

Initializers

import io.cdktn.providers.github.provider.GithubProvider;

GithubProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .appAuth(GithubProviderAppAuth)
//  .baseUrl(java.lang.String)
//  .cachePath(java.lang.String)
//  .insecure(java.lang.Boolean|IResolvable)
//  .legacyClient(java.lang.Boolean|IResolvable)
//  .maxPerPage(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .organization(java.lang.String)
//  .owner(java.lang.String)
//  .parallelRequests(java.lang.Boolean|IResolvable)
//  .readDelayMs(java.lang.Number)
//  .retryableErrors(java.util.List<java.lang.Number>)
//  .retryDelayMs(java.lang.Number)
//  .token(java.lang.String)
//  .writeDelayMs(java.lang.Number)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	The scope in which to define this construct.
`id`	`java.lang.String`	The scoped construct ID.
`alias`	`java.lang.String`	Alias name.
`appAuth`	`GithubProviderAppAuth`	app_auth block.
`baseUrl`	`java.lang.String`	The base URL for the GitHub API;
`cachePath`	`java.lang.String`	The path to the cache directory for persisting GitHub API requests between runs;
`insecure`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Allow insecure server connections when using SSL.
`legacyClient`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Use the legacy GitHub client implementation;
`maxPerPage`	`java.lang.Number`	The maximum number of results per page for paginated API requests;
`maxRetries`	`java.lang.Number`	The maximum number of retries for failed requests; this defaults to `3`.
`organization`	`java.lang.String`	GitHub organization to manage. This can also be set by the `GITHUB_ORGANIZATION` environment variable.
`owner`	`java.lang.String`	GitHub organization or user account to manage;
`parallelRequests`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Allow the provider to make parallel API calls;
`readDelayMs`	`java.lang.Number`	The delay in milliseconds between read operations;
`retryableErrors`	`java.util.List<java.lang.Number>`	List of HTTP status codes that should be retried;
`retryDelayMs`	`java.lang.Number`	The delay in milliseconds between retry attempts;
`token`	`java.lang.String`	GitHub OAuth or Personal Access Token (PAT) to use for authentication.
`writeDelayMs`	`java.lang.Number`	The delay in milliseconds between write operations;

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`alias`^Optional

Type: java.lang.String

Alias name.

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

`appAuth`^Optional

Type: GithubProviderAppAuth

app_auth block.

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

`baseUrl`^Optional

Type: java.lang.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.

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

`cachePath`^Optional

Type: java.lang.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.

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

`insecure`^Optional

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Allow insecure server connections when using SSL.

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

`legacyClient`^Optional

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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.

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

`maxPerPage`^Optional

Type: java.lang.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.

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

`maxRetries`^Optional

Type: java.lang.Number

The maximum number of retries for failed requests; this defaults to 3.

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

`organization`^Optional

Type: java.lang.String

GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.

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

`owner`^Optional

Type: java.lang.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.

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

`parallelRequests`^Optional

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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 legacy_client is false since the new client implementation is designed to safely handle parallel requests.

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

`readDelayMs`^Optional

Type: java.lang.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 legacy_client is false since the new client implementation is GitHub rate limit aware.

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

`retryableErrors`^Optional

Type: java.util.List<java.lang.Number>

List of HTTP status codes that should be retried;

if not set this uses the provider defaults. This setting only applies when max_retries is greater than 0. This is ignored for the REST API when legacy_client is false since the new client implementation handles the retry logic.

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

`retryDelayMs`^Optional

Type: java.lang.Number

The delay in milliseconds between retry attempts;

this defaults to 1000. This setting only applies when max_retries is greater than 0.

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

`token`^Optional

Type: java.lang.String

GitHub OAuth or Personal Access Token (PAT) to use for authentication.

This can also be set by the GITHUB_TOKEN environment variable.

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

`writeDelayMs`^Optional

Type: java.lang.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 legacy_client is false since the new client implementation is GitHub rate limit aware.

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

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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.
`resetCachePath`	No description.
`resetInsecure`	No description.
`resetLegacyClient`	No description.
`resetMaxPerPage`	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`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin...

The mixins to apply.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

Type: java.lang.String

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public void resetOverrideLogicalId()

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

`toHclTerraform`

public java.lang.Object toHclTerraform()

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`resetAlias`

public void resetAlias()

`resetAppAuth`

public void resetAppAuth()

`resetBaseUrl`

public void resetBaseUrl()

`resetCachePath`

public void resetCachePath()

`resetInsecure`

public void resetInsecure()

`resetLegacyClient`

public void resetLegacyClient()

`resetMaxPerPage`

public void resetMaxPerPage()

`resetMaxRetries`

public void resetMaxRetries()

`resetOrganization`

public void resetOrganization()

`resetOwner`

public void resetOwner()

`resetParallelRequests`

public void resetParallelRequests()

`resetReadDelayMs`

public void resetReadDelayMs()

`resetRetryableErrors`

public void resetRetryableErrors()

`resetRetryDelayMs`

public void resetRetryDelayMs()

`resetToken`

public void resetToken()

`resetWriteDelayMs`

public void resetWriteDelayMs()

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformProvider`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a GithubProvider resource upon running "cdktn plan ".

`isConstruct`

import io.cdktn.providers.github.provider.GithubProvider;

GithubProvider.isConstruct(java.lang.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.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.providers.github.provider.GithubProvider;

GithubProvider.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformProvider`

import io.cdktn.providers.github.provider.GithubProvider;

GithubProvider.isTerraformProvider(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import io.cdktn.providers.github.provider.GithubProvider;

GithubProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GithubProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a GithubProvider resource upon running "cdktn plan ".

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing GithubProvider that should be imported.

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

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`io.cdktn.cdktn.TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.
`metaAttributes`	`java.util.Map<java.lang.String, java.lang.Object>`	No description.
`terraformResourceType`	`java.lang.String`	No description.
`terraformGeneratorMetadata`	`io.cdktn.cdktn.TerraformProviderGeneratorMetadata`	No description.
`terraformProviderSource`	`java.lang.String`	No description.
`alias`	`java.lang.String`	No description.
`aliasInput`	`java.lang.String`	No description.
`appAuthInput`	`GithubProviderAppAuth`	No description.
`baseUrlInput`	`java.lang.String`	No description.
`cachePathInput`	`java.lang.String`	No description.
`insecureInput`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`legacyClientInput`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`maxPerPageInput`	`java.lang.Number`	No description.
`maxRetriesInput`	`java.lang.Number`	No description.
`organizationInput`	`java.lang.String`	No description.
`ownerInput`	`java.lang.String`	No description.
`parallelRequestsInput`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`readDelayMsInput`	`java.lang.Number`	No description.
`retryableErrorsInput`	`java.util.List<java.lang.Number>`	No description.
`retryDelayMsInput`	`java.lang.Number`	No description.
`tokenInput`	`java.lang.String`	No description.
`writeDelayMsInput`	`java.lang.Number`	No description.
`appAuth`	`GithubProviderAppAuth`	No description.
`baseUrl`	`java.lang.String`	No description.
`cachePath`	`java.lang.String`	No description.
`insecure`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`legacyClient`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`maxPerPage`	`java.lang.Number`	No description.
`maxRetries`	`java.lang.Number`	No description.
`organization`	`java.lang.String`	No description.
`owner`	`java.lang.String`	No description.
`parallelRequests`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`readDelayMs`	`java.lang.Number`	No description.
`retryableErrors`	`java.util.List<java.lang.Number>`	No description.
`retryDelayMs`	`java.lang.Number`	No description.
`token`	`java.lang.String`	No description.
`writeDelayMs`	`java.lang.Number`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: io.cdktn.cdktn.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`metaAttributes`^Required

public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata

`terraformProviderSource`^Optional

public java.lang.String getTerraformProviderSource();

Type: java.lang.String

`alias`^Optional

public java.lang.String getAlias();

Type: java.lang.String

`aliasInput`^Optional

public java.lang.String getAliasInput();

Type: java.lang.String

`appAuthInput`^Optional

public GithubProviderAppAuth getAppAuthInput();

Type: GithubProviderAppAuth

`baseUrlInput`^Optional

public java.lang.String getBaseUrlInput();

Type: java.lang.String

`cachePathInput`^Optional

public java.lang.String getCachePathInput();

Type: java.lang.String

`insecureInput`^Optional

public java.lang.Boolean|IResolvable getInsecureInput();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`legacyClientInput`^Optional

public java.lang.Boolean|IResolvable getLegacyClientInput();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`maxPerPageInput`^Optional

public java.lang.Number getMaxPerPageInput();

Type: java.lang.Number

`maxRetriesInput`^Optional

public java.lang.Number getMaxRetriesInput();

Type: java.lang.Number

`organizationInput`^Optional

public java.lang.String getOrganizationInput();

Type: java.lang.String

`ownerInput`^Optional

public java.lang.String getOwnerInput();

Type: java.lang.String

`parallelRequestsInput`^Optional

public java.lang.Boolean|IResolvable getParallelRequestsInput();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`readDelayMsInput`^Optional

public java.lang.Number getReadDelayMsInput();

Type: java.lang.Number

`retryableErrorsInput`^Optional

public java.util.List<java.lang.Number> getRetryableErrorsInput();

Type: java.util.List<java.lang.Number>

`retryDelayMsInput`^Optional

public java.lang.Number getRetryDelayMsInput();

Type: java.lang.Number

`tokenInput`^Optional

public java.lang.String getTokenInput();

Type: java.lang.String

`writeDelayMsInput`^Optional

public java.lang.Number getWriteDelayMsInput();

Type: java.lang.Number

`appAuth`^Optional

public GithubProviderAppAuth getAppAuth();

Type: GithubProviderAppAuth

`baseUrl`^Optional

public java.lang.String getBaseUrl();

Type: java.lang.String

`cachePath`^Optional

public java.lang.String getCachePath();

Type: java.lang.String

`insecure`^Optional

public java.lang.Boolean|IResolvable getInsecure();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`legacyClient`^Optional

public java.lang.Boolean|IResolvable getLegacyClient();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`maxPerPage`^Optional

public java.lang.Number getMaxPerPage();

Type: java.lang.Number

`maxRetries`^Optional

public java.lang.Number getMaxRetries();

Type: java.lang.Number

`organization`^Optional

public java.lang.String getOrganization();

Type: java.lang.String

`owner`^Optional

public java.lang.String getOwner();

Type: java.lang.String

`parallelRequests`^Optional

public java.lang.Boolean|IResolvable getParallelRequests();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`readDelayMs`^Optional

public java.lang.Number getReadDelayMs();

Type: java.lang.Number

`retryableErrors`^Optional

public java.util.List<java.lang.Number> getRetryableErrors();

Type: java.util.List<java.lang.Number>

`retryDelayMs`^Optional

public java.lang.Number getRetryDelayMs();

Type: java.lang.Number

`token`^Optional

public java.lang.String getToken();

Type: java.lang.String

`writeDelayMs`^Optional

public java.lang.Number getWriteDelayMs();

Type: java.lang.Number

Constants

Name	Type	Description
`tfResourceType`	`java.lang.String`	No description.

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

GithubProviderAppAuth

Initializer

import io.cdktn.providers.github.provider.GithubProviderAppAuth;

GithubProviderAppAuth.builder()
    .id(java.lang.String)
    .installationId(java.lang.String)
    .pemFile(java.lang.String)
    .build();

Properties

Name	Type	Description
`id`	`java.lang.String`	The GitHub App's identifier. This can also be set by the `GITHUB_APP_ID` environment variable.
`installationId`	`java.lang.String`	The GitHub App's installation identifier. This can also be set by the `GITHUB_APP_INSTALLATION_ID` environment variable.
`pemFile`	`java.lang.String`	The GitHub App's PEM file content;

`id`^Required

public java.lang.String getId();

Type: java.lang.String

The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.

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

`installationId`^Required

public java.lang.String getInstallationId();

Type: java.lang.String

The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.

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

`pemFile`^Required

public java.lang.String getPemFile();

Type: java.lang.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.

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

GithubProviderConfig

Initializer

import io.cdktn.providers.github.provider.GithubProviderConfig;

GithubProviderConfig.builder()
//  .alias(java.lang.String)
//  .appAuth(GithubProviderAppAuth)
//  .baseUrl(java.lang.String)
//  .cachePath(java.lang.String)
//  .insecure(java.lang.Boolean|IResolvable)
//  .legacyClient(java.lang.Boolean|IResolvable)
//  .maxPerPage(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .organization(java.lang.String)
//  .owner(java.lang.String)
//  .parallelRequests(java.lang.Boolean|IResolvable)
//  .readDelayMs(java.lang.Number)
//  .retryableErrors(java.util.List<java.lang.Number>)
//  .retryDelayMs(java.lang.Number)
//  .token(java.lang.String)
//  .writeDelayMs(java.lang.Number)
    .build();

Properties

Name	Type	Description
`alias`	`java.lang.String`	Alias name.
`appAuth`	`GithubProviderAppAuth`	app_auth block.
`baseUrl`	`java.lang.String`	The base URL for the GitHub API;
`cachePath`	`java.lang.String`	The path to the cache directory for persisting GitHub API requests between runs;
`insecure`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Allow insecure server connections when using SSL.
`legacyClient`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Use the legacy GitHub client implementation;
`maxPerPage`	`java.lang.Number`	The maximum number of results per page for paginated API requests;
`maxRetries`	`java.lang.Number`	The maximum number of retries for failed requests; this defaults to `3`.
`organization`	`java.lang.String`	GitHub organization to manage. This can also be set by the `GITHUB_ORGANIZATION` environment variable.
`owner`	`java.lang.String`	GitHub organization or user account to manage;
`parallelRequests`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	Allow the provider to make parallel API calls;
`readDelayMs`	`java.lang.Number`	The delay in milliseconds between read operations;
`retryableErrors`	`java.util.List<java.lang.Number>`	List of HTTP status codes that should be retried;
`retryDelayMs`	`java.lang.Number`	The delay in milliseconds between retry attempts;
`token`	`java.lang.String`	GitHub OAuth or Personal Access Token (PAT) to use for authentication.
`writeDelayMs`	`java.lang.Number`	The delay in milliseconds between write operations;

`alias`^Optional

public java.lang.String getAlias();

Type: java.lang.String

Alias name.

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

`appAuth`^Optional

public GithubProviderAppAuth getAppAuth();

Type: GithubProviderAppAuth

app_auth block.

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

`baseUrl`^Optional

public java.lang.String getBaseUrl();

Type: java.lang.String

The base URL for the GitHub API;

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

`cachePath`^Optional

public java.lang.String getCachePath();

Type: java.lang.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.

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

`insecure`^Optional

public java.lang.Boolean|IResolvable getInsecure();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Allow insecure server connections when using SSL.

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

`legacyClient`^Optional

public java.lang.Boolean|IResolvable getLegacyClient();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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.

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

`maxPerPage`^Optional

public java.lang.Number getMaxPerPage();

Type: java.lang.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.

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

`maxRetries`^Optional

public java.lang.Number getMaxRetries();

Type: java.lang.Number

The maximum number of retries for failed requests; this defaults to 3.

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

`organization`^Optional

public java.lang.String getOrganization();

Type: java.lang.String

GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.

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

`owner`^Optional

public java.lang.String getOwner();

Type: java.lang.String

GitHub organization or user account to manage;

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

`parallelRequests`^Optional

public java.lang.Boolean|IResolvable getParallelRequests();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Allow the provider to make parallel API calls;

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

`readDelayMs`^Optional

public java.lang.Number getReadDelayMs();

Type: java.lang.Number

The delay in milliseconds between read operations;

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

`retryableErrors`^Optional

public java.util.List<java.lang.Number> getRetryableErrors();

Type: java.util.List<java.lang.Number>

List of HTTP status codes that should be retried;

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

`retryDelayMs`^Optional

public java.lang.Number getRetryDelayMs();

Type: java.lang.Number

The delay in milliseconds between retry attempts;

this defaults to 1000. This setting only applies when max_retries is greater than 0.

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

`token`^Optional

public java.lang.String getToken();

Type: java.lang.String

GitHub OAuth or Personal Access Token (PAT) to use for authentication.

This can also be set by the GITHUB_TOKEN environment variable.

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

`writeDelayMs`^Optional

public java.lang.Number getWriteDelayMs();

Type: java.lang.Number

The delay in milliseconds between write operations;

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

Uh oh!

FilesExpand file tree

provider.java.md

Latest commit

History

provider.java.md

File metadata and controls

provider Submodule

Constructs

GithubProvider

Initializers

scopeRequired

idRequired

aliasOptional

appAuthOptional

baseUrlOptional

cachePathOptional

insecureOptional

legacyClientOptional

maxPerPageOptional

maxRetriesOptional

organizationOptional

ownerOptional

parallelRequestsOptional

readDelayMsOptional

retryableErrorsOptional

retryDelayMsOptional

tokenOptional

writeDelayMsOptional

Methods

toString

with

mixinsRequired

addOverride

pathRequired

valueRequired

overrideLogicalId

newLogicalIdRequired

resetOverrideLogicalId

toHclTerraform

toMetadata

toTerraform

resetAlias

resetAppAuth

resetBaseUrl

resetCachePath

resetInsecure

resetLegacyClient

resetMaxPerPage

resetMaxRetries

resetOrganization

resetOwner

resetParallelRequests

resetReadDelayMs

resetRetryableErrors

resetRetryDelayMs

resetToken

resetWriteDelayMs

Static Functions

isConstruct

xRequired

isTerraformElement

xRequired

isTerraformProvider

xRequired

generateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

providerOptional

Properties

nodeRequired

cdktfStackRequired

fqnRequired

friendlyUniqueIdRequired

metaAttributesRequired

terraformResourceTypeRequired

terraformGeneratorMetadataOptional

terraformProviderSourceOptional

aliasOptional

`provider` Submodule

`scope`^Required

`id`^Required

`alias`^Optional

`appAuth`^Optional

`baseUrl`^Optional

`cachePath`^Optional

`insecure`^Optional

`legacyClient`^Optional

`maxPerPage`^Optional

`maxRetries`^Optional

`organization`^Optional

`owner`^Optional

`parallelRequests`^Optional

`readDelayMs`^Optional

`retryableErrors`^Optional

`retryDelayMs`^Optional

`token`^Optional

`writeDelayMs`^Optional

`toString`

`with`

`mixins`^Required

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`resetAlias`

`resetAppAuth`

`resetBaseUrl`

`resetCachePath`

`resetInsecure`

`resetLegacyClient`

`resetMaxPerPage`

`resetMaxRetries`

`resetOrganization`

`resetOwner`

`resetParallelRequests`

`resetReadDelayMs`

`resetRetryableErrors`

`resetRetryDelayMs`

`resetToken`

`resetWriteDelayMs`

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformProvider`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`metaAttributes`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`terraformProviderSource`^Optional

`alias`^Optional

`aliasInput`^Optional

`appAuthInput`^Optional

`baseUrlInput`^Optional

`cachePathInput`^Optional

`insecureInput`^Optional

`legacyClientInput`^Optional

`maxPerPageInput`^Optional

`maxRetriesInput`^Optional

`organizationInput`^Optional

`ownerInput`^Optional

`parallelRequestsInput`^Optional

`readDelayMsInput`^Optional

`retryableErrorsInput`^Optional