Represents a {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs github}.
from cdktf_cdktf_provider_github import provider
provider.GithubProvider(
scope: Construct,
id: str,
alias: str = None,
app_auth: GithubProviderAppAuth = None,
base_url: str = None,
insecure: typing.Union[bool, IResolvable] = None,
max_retries: typing.Union[int, float] = None,
organization: str = None,
owner: str = None,
parallel_requests: typing.Union[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 GitHub Base API URL. |
insecure |
typing.Union[bool, cdktf.IResolvable] |
Enable insecure mode for testing purposes. |
max_retries |
typing.Union[int, float] |
Number of times to retry a request after receiving an error status codeDefaults to 3. |
organization |
str |
The GitHub organization name to manage. Use this field instead of owner when managing organization accounts. |
owner |
str |
The GitHub owner name to manage. Use this field instead of organization when managing individual accounts. |
parallel_requests |
typing.Union[bool, cdktf.IResolvable] |
Allow the provider to make parallel API calls to GitHub. |
read_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between non-write requests to GitHub API. |
retryable_errors |
typing.List[typing.Union[int, float]] |
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]. |
retry_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. |
token |
str |
The OAuth token used to connect to GitHub. |
write_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between writes to GitHub API. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: str
Alias name.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#alias GithubProvider#alias}
- Type: GithubProviderAppAuth
app_auth block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#app_auth GithubProvider#app_auth}
- Type: str
The GitHub Base API URL.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#base_url GithubProvider#base_url}
- Type: typing.Union[bool, cdktf.IResolvable]
Enable insecure
mode for testing purposes.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#insecure GithubProvider#insecure}
- Type: typing.Union[int, float]
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.4.0/docs#max_retries GithubProvider#max_retries}
- Type: str
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.4.0/docs#organization GithubProvider#organization}
- Type: str
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.4.0/docs#owner GithubProvider#owner}
- Type: typing.Union[bool, cdktf.IResolvable]
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.4.0/docs#parallel_requests GithubProvider#parallel_requests}
- Type: typing.Union[int, float]
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.4.0/docs#read_delay_ms GithubProvider#read_delay_ms}
- Type: typing.List[typing.Union[int, float]]
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.4.0/docs#retryable_errors GithubProvider#retryable_errors}
- Type: typing.Union[int, float]
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.4.0/docs#retry_delay_ms GithubProvider#retry_delay_ms}
- Type: str
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.4.0/docs#token GithubProvider#token}
- Type: typing.Union[int, float]
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.4.0/docs#write_delay_ms GithubProvider#write_delay_ms}
Name | Description |
---|---|
to_string |
Returns a string representation of 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_insecure |
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. |
def to_string() -> str
Returns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def reset_alias() -> None
def reset_app_auth() -> None
def reset_base_url() -> None
def reset_insecure() -> None
def reset_max_retries() -> None
def reset_organization() -> None
def reset_owner() -> None
def reset_parallel_requests() -> None
def reset_read_delay_ms() -> None
def reset_retryable_errors() -> None
def reset_retry_delay_ms() -> None
def reset_token() -> None
def reset_write_delay_ms() -> None
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 CDKTF code for importing a GithubProvider resource upon running "cdktf plan ". |
from cdktf_cdktf_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.
- Type: typing.Any
Any object.
from cdktf_cdktf_provider_github import provider
provider.GithubProvider.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_github import provider
provider.GithubProvider.is_terraform_provider(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_github import provider
provider.GithubProvider.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a GithubProvider resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the GithubProvider to import.
- Type: str
The id of the existing GithubProvider that should be imported.
Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the GithubProvider to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktf.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 |
cdktf.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. |
insecure_input |
typing.Union[bool, cdktf.IResolvable] |
No description. |
max_retries_input |
typing.Union[int, float] |
No description. |
organization_input |
str |
No description. |
owner_input |
str |
No description. |
parallel_requests_input |
typing.Union[bool, cdktf.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. |
insecure |
typing.Union[bool, cdktf.IResolvable] |
No description. |
max_retries |
typing.Union[int, float] |
No description. |
organization |
str |
No description. |
owner |
str |
No description. |
parallel_requests |
typing.Union[bool, cdktf.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. |
node: Node
- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack
- Type: cdktf.TerraformStack
fqn: str
- Type: str
friendly_unique_id: str
- Type: str
meta_attributes: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
- Type: cdktf.TerraformProviderGeneratorMetadata
terraform_provider_source: str
- Type: str
alias: str
- Type: str
alias_input: str
- Type: str
app_auth_input: GithubProviderAppAuth
- Type: GithubProviderAppAuth
base_url_input: str
- Type: str
insecure_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
max_retries_input: typing.Union[int, float]
- Type: typing.Union[int, float]
organization_input: str
- Type: str
owner_input: str
- Type: str
parallel_requests_input: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
read_delay_ms_input: typing.Union[int, float]
- Type: typing.Union[int, float]
retryable_errors_input: typing.List[typing.Union[int, float]]
- Type: typing.List[typing.Union[int, float]]
retry_delay_ms_input: typing.Union[int, float]
- Type: typing.Union[int, float]
token_input: str
- Type: str
write_delay_ms_input: typing.Union[int, float]
- Type: typing.Union[int, float]
app_auth: GithubProviderAppAuth
- Type: GithubProviderAppAuth
base_url: str
- Type: str
insecure: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
max_retries: typing.Union[int, float]
- Type: typing.Union[int, float]
organization: str
- Type: str
owner: str
- Type: str
parallel_requests: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
read_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
retryable_errors: typing.List[typing.Union[int, float]]
- Type: typing.List[typing.Union[int, float]]
retry_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
token: str
- Type: str
write_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_github import provider
provider.GithubProviderAppAuth(
id: str,
installation_id: str,
pem_file: str
)
Name | Type | Description |
---|---|---|
id |
str |
The GitHub App ID. |
installation_id |
str |
The GitHub App installation instance ID. |
pem_file |
str |
The GitHub App PEM file contents. |
id: str
- Type: str
The GitHub App ID.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.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_id: str
- Type: str
The GitHub App installation instance ID.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#installation_id GithubProvider#installation_id}
pem_file: str
- Type: str
The GitHub App PEM file contents.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#pem_file GithubProvider#pem_file}
from cdktf_cdktf_provider_github import provider
provider.GithubProviderConfig(
alias: str = None,
app_auth: GithubProviderAppAuth = None,
base_url: str = None,
insecure: typing.Union[bool, IResolvable] = None,
max_retries: typing.Union[int, float] = None,
organization: str = None,
owner: str = None,
parallel_requests: typing.Union[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 |
---|---|---|
alias |
str |
Alias name. |
app_auth |
GithubProviderAppAuth |
app_auth block. |
base_url |
str |
The GitHub Base API URL. |
insecure |
typing.Union[bool, cdktf.IResolvable] |
Enable insecure mode for testing purposes. |
max_retries |
typing.Union[int, float] |
Number of times to retry a request after receiving an error status codeDefaults to 3. |
organization |
str |
The GitHub organization name to manage. Use this field instead of owner when managing organization accounts. |
owner |
str |
The GitHub owner name to manage. Use this field instead of organization when managing individual accounts. |
parallel_requests |
typing.Union[bool, cdktf.IResolvable] |
Allow the provider to make parallel API calls to GitHub. |
read_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between non-write requests to GitHub API. |
retryable_errors |
typing.List[typing.Union[int, float]] |
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]. |
retry_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between requests to GitHub API after an error response. |
token |
str |
The OAuth token used to connect to GitHub. |
write_delay_ms |
typing.Union[int, float] |
Amount of time in milliseconds to sleep in between writes to GitHub API. |
alias: str
- Type: str
Alias name.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#alias GithubProvider#alias}
app_auth: GithubProviderAppAuth
- Type: GithubProviderAppAuth
app_auth block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#app_auth GithubProvider#app_auth}
base_url: str
- Type: str
The GitHub Base API URL.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#base_url GithubProvider#base_url}
insecure: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
Enable insecure
mode for testing purposes.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs#insecure GithubProvider#insecure}
max_retries: typing.Union[int, float]
- Type: typing.Union[int, float]
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.4.0/docs#max_retries GithubProvider#max_retries}
organization: str
- Type: str
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.4.0/docs#organization GithubProvider#organization}
owner: str
- Type: str
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.4.0/docs#owner GithubProvider#owner}
parallel_requests: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, cdktf.IResolvable]
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.4.0/docs#parallel_requests GithubProvider#parallel_requests}
read_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
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.4.0/docs#read_delay_ms GithubProvider#read_delay_ms}
retryable_errors: typing.List[typing.Union[int, float]]
- Type: typing.List[typing.Union[int, float]]
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.4.0/docs#retryable_errors GithubProvider#retryable_errors}
retry_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
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.4.0/docs#retry_delay_ms GithubProvider#retry_delay_ms}
token: str
- Type: str
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.4.0/docs#token GithubProvider#token}
write_delay_ms: typing.Union[int, float]
- Type: typing.Union[int, float]
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.4.0/docs#write_delay_ms GithubProvider#write_delay_ms}