Skip to content

provider.python.md

Latest commit

 

History

History
1447 lines (906 loc) · 58.8 KB

provider.python.md

File metadata and controls

1447 lines (906 loc) · 58.8 KB
Raw

provider Submodule

Constructs

GithubProvider

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

Initializers 

from cdktn_provider_github import provider

provider.GithubProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  app_auth: GithubProviderAppAuth = None,
  base_url: str = None,
  cache_path: str = None,
  insecure: bool | IResolvable = None,
  legacy_client: bool | IResolvable = None,
  max_per_page: typing.Union[int, float] = None,
  max_retries: typing.Union[int, float] = None,
  organization: str = None,
  owner: str = None,
  parallel_requests: bool | IResolvable = None,
  read_delay_ms: typing.Union[int, float] = None,
  retryable_errors: typing.List[typing.Union[int, float]] = None,
  retry_delay_ms: typing.Union[int, float] = None,
  token: str = None,
  write_delay_ms: typing.Union[int, float] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
app_auth GithubProviderAppAuth app_auth block.
base_url str The base URL for the GitHub API;
cache_path str The path to the cache directory for persisting GitHub API requests between runs;
insecure bool | cdktn.IResolvable Allow insecure server connections when using SSL.
legacy_client bool | cdktn.IResolvable Use the legacy GitHub client implementation;
max_per_page typing.Union[int, float] The maximum number of results per page for paginated API requests;
max_retries typing.Union[int, float] The maximum number of retries for failed requests; this defaults to 3.
organization str GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
owner str GitHub organization or user account to manage;
parallel_requests bool | cdktn.IResolvable Allow the provider to make parallel API calls;
read_delay_ms typing.Union[int, float] The delay in milliseconds between read operations;
retryable_errors typing.List[typing.Union[int, float]] List of HTTP status codes that should be retried;
retry_delay_ms typing.Union[int, float] The delay in milliseconds between retry attempts;
token str GitHub OAuth or Personal Access Token (PAT) to use for authentication.
write_delay_ms typing.Union[int, float] The delay in milliseconds between write operations;
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: str

Alias name.

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

app_authOptional

app_auth block.

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

base_urlOptional
  • Type: str

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}

cache_pathOptional
  • Type: str

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}

insecureOptional
  • Type: bool | 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}

legacy_clientOptional
  • Type: bool | 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}

max_per_pageOptional
  • Type: typing.Union[int, float]

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}

max_retriesOptional
  • Type: typing.Union[int, float]

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}

organizationOptional
  • Type: str

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}

ownerOptional
  • Type: str

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}

parallel_requestsOptional
  • Type: bool | 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}

read_delay_msOptional
  • Type: typing.Union[int, float]

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}

retryable_errorsOptional
  • Type: typing.List[typing.Union[int, float]]

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}

retry_delay_msOptional
  • Type: typing.Union[int, float]

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}

tokenOptional
  • Type: str

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}

write_delay_msOptional
  • Type: typing.Union[int, float]

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
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
reset_alias No description.
reset_app_auth No description.
reset_base_url No description.
reset_cache_path No description.
reset_insecure No description.
reset_legacy_client No description.
reset_max_per_page No description.
reset_max_retries No description.
reset_organization No description.
reset_owner No description.
reset_parallel_requests No description.
reset_read_delay_ms No description.
reset_retryable_errors No description.
reset_retry_delay_ms No description.
reset_token No description.
reset_write_delay_ms No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

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.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

reset_alias 
def reset_alias() -> None
reset_app_auth 
def reset_app_auth() -> None
reset_base_url 
def reset_base_url() -> None
reset_cache_path 
def reset_cache_path() -> None
reset_insecure 
def reset_insecure() -> None
reset_legacy_client 
def reset_legacy_client() -> None
reset_max_per_page 
def reset_max_per_page() -> None
reset_max_retries 
def reset_max_retries() -> None
reset_organization 
def reset_organization() -> None
reset_owner 
def reset_owner() -> None
reset_parallel_requests 
def reset_parallel_requests() -> None
reset_read_delay_ms 
def reset_read_delay_ms() -> None
reset_retryable_errors 
def reset_retryable_errors() -> None
reset_retry_delay_ms 
def reset_retry_delay_ms() -> None
reset_token 
def reset_token() -> None
reset_write_delay_ms 
def reset_write_delay_ms() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTN code for importing a GithubProvider resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_github import provider

provider.GithubProvider.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktn_provider_github import provider

provider.GithubProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktn_provider_github import provider

provider.GithubProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_github import provider

provider.GithubProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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

providerOptional
  • Type: cdktn.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
app_auth_input GithubProviderAppAuth No description.
base_url_input str No description.
cache_path_input str No description.
insecure_input bool | cdktn.IResolvable No description.
legacy_client_input bool | cdktn.IResolvable No description.
max_per_page_input typing.Union[int, float] No description.
max_retries_input typing.Union[int, float] No description.
organization_input str No description.
owner_input str No description.
parallel_requests_input bool | cdktn.IResolvable No description.
read_delay_ms_input typing.Union[int, float] No description.
retryable_errors_input typing.List[typing.Union[int, float]] No description.
retry_delay_ms_input typing.Union[int, float] No description.
token_input str No description.
write_delay_ms_input typing.Union[int, float] No description.
app_auth GithubProviderAppAuth No description.
base_url str No description.
cache_path str No description.
insecure bool | cdktn.IResolvable No description.
legacy_client bool | cdktn.IResolvable No description.
max_per_page typing.Union[int, float] No description.
max_retries typing.Union[int, float] No description.
organization str No description.
owner str No description.
parallel_requests bool | cdktn.IResolvable No description.
read_delay_ms typing.Union[int, float] No description.
retryable_errors typing.List[typing.Union[int, float]] No description.
retry_delay_ms typing.Union[int, float] No description.
token str No description.
write_delay_ms typing.Union[int, float] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
meta_attributesRequired 
meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
app_auth_inputOptional 
app_auth_input: GithubProviderAppAuth
base_url_inputOptional 
base_url_input: str
  • Type: str
cache_path_inputOptional 
cache_path_input: str
  • Type: str
insecure_inputOptional 
insecure_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
legacy_client_inputOptional 
legacy_client_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
max_per_page_inputOptional 
max_per_page_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_retries_inputOptional 
max_retries_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
organization_inputOptional 
organization_input: str
  • Type: str
owner_inputOptional 
owner_input: str
  • Type: str
parallel_requests_inputOptional 
parallel_requests_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
read_delay_ms_inputOptional 
read_delay_ms_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
retryable_errors_inputOptional 
retryable_errors_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
retry_delay_ms_inputOptional 
retry_delay_ms_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
token_inputOptional 
token_input: str
  • Type: str
write_delay_ms_inputOptional 
write_delay_ms_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
app_authOptional 
app_auth: GithubProviderAppAuth
base_urlOptional 
base_url: str
  • Type: str
cache_pathOptional 
cache_path: str
  • Type: str
insecureOptional 
insecure: bool | IResolvable
  • Type: bool | cdktn.IResolvable
legacy_clientOptional 
legacy_client: bool | IResolvable
  • Type: bool | cdktn.IResolvable
max_per_pageOptional 
max_per_page: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_retriesOptional 
max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]
organizationOptional 
organization: str
  • Type: str
ownerOptional 
owner: str
  • Type: str
parallel_requestsOptional 
parallel_requests: bool | IResolvable
  • Type: bool | cdktn.IResolvable
read_delay_msOptional 
read_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]
retryable_errorsOptional 
retryable_errors: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
retry_delay_msOptional 
retry_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]
tokenOptional 
token: str
  • Type: str
write_delay_msOptional 
write_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

GithubProviderAppAuth

Initializer 

from cdktn_provider_github import provider

provider.GithubProviderAppAuth(
  id: str,
  installation_id: str,
  pem_file: str
)

Properties

Name Type Description
id str The GitHub App's identifier. This can also be set by the GITHUB_APP_ID environment variable.
installation_id str The GitHub App's installation identifier. This can also be set by the GITHUB_APP_INSTALLATION_ID environment variable.
pem_file str The GitHub App's PEM file content;
idRequired 
id: str
  • Type: str

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.

installation_idRequired 
installation_id: str
  • Type: str

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}

pem_fileRequired 
pem_file: str
  • Type: str

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 

from cdktn_provider_github import provider

provider.GithubProviderConfig(
  alias: str = None,
  app_auth: GithubProviderAppAuth = None,
  base_url: str = None,
  cache_path: str = None,
  insecure: bool | IResolvable = None,
  legacy_client: bool | IResolvable = None,
  max_per_page: typing.Union[int, float] = None,
  max_retries: typing.Union[int, float] = None,
  organization: str = None,
  owner: str = None,
  parallel_requests: bool | IResolvable = None,
  read_delay_ms: typing.Union[int, float] = None,
  retryable_errors: typing.List[typing.Union[int, float]] = None,
  retry_delay_ms: typing.Union[int, float] = None,
  token: str = None,
  write_delay_ms: typing.Union[int, float] = None
)

Properties

Name Type Description
alias str Alias name.
app_auth GithubProviderAppAuth app_auth block.
base_url str The base URL for the GitHub API;
cache_path str The path to the cache directory for persisting GitHub API requests between runs;
insecure bool | cdktn.IResolvable Allow insecure server connections when using SSL.
legacy_client bool | cdktn.IResolvable Use the legacy GitHub client implementation;
max_per_page typing.Union[int, float] The maximum number of results per page for paginated API requests;
max_retries typing.Union[int, float] The maximum number of retries for failed requests; this defaults to 3.
organization str GitHub organization to manage. This can also be set by the GITHUB_ORGANIZATION environment variable.
owner str GitHub organization or user account to manage;
parallel_requests bool | cdktn.IResolvable Allow the provider to make parallel API calls;
read_delay_ms typing.Union[int, float] The delay in milliseconds between read operations;
retryable_errors typing.List[typing.Union[int, float]] List of HTTP status codes that should be retried;
retry_delay_ms typing.Union[int, float] The delay in milliseconds between retry attempts;
token str GitHub OAuth or Personal Access Token (PAT) to use for authentication.
write_delay_ms typing.Union[int, float] The delay in milliseconds between write operations;
aliasOptional 
alias: str
  • Type: str

Alias name.

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

app_authOptional 
app_auth: 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}

base_urlOptional 
base_url: str
  • Type: str

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}

cache_pathOptional 
cache_path: str
  • Type: str

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}

insecureOptional 
insecure: bool | IResolvable
  • Type: bool | 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}

legacy_clientOptional 
legacy_client: bool | IResolvable
  • Type: bool | 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}

max_per_pageOptional 
max_per_page: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

max_retriesOptional 
max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

organizationOptional 
organization: str
  • Type: str

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}

ownerOptional 
owner: str
  • Type: str

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}

parallel_requestsOptional 
parallel_requests: bool | IResolvable
  • Type: bool | 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}

read_delay_msOptional 
read_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

retryable_errorsOptional 
retryable_errors: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

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}

retry_delay_msOptional 
retry_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

tokenOptional 
token: str
  • Type: str

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}

write_delay_msOptional 
write_delay_ms: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}