Skip to content

Latest commit

 

History

History
1212 lines (755 loc) · 50.1 KB

provider.java.md

File metadata and controls

1212 lines (755 loc) · 50.1 KB
Raw

provider Submodule

Constructs

GithubProvider

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

Initializers 

import com.hashicorp.cdktf.providers.github.provider.GithubProvider;

GithubProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .appAuth(GithubProviderAppAuth)
//  .baseUrl(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .maxRetries(java.lang.Number)
//  .organization(java.lang.String)
//  .owner(java.lang.String)
//  .parallelRequests(java.lang.Boolean)
//  .parallelRequests(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 GitHub Base API URL.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable insecure mode for testing purposes.
maxRetries java.lang.Number Number of times to retry a request after receiving an error status codeDefaults to 3.
organization java.lang.String The GitHub organization name to manage. Use this field instead of owner when managing organization accounts.
owner java.lang.String The GitHub owner name to manage. Use this field instead of organization when managing individual accounts.
parallelRequests java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allow the provider to make parallel API calls to GitHub.
readDelayMs java.lang.Number Amount of time in milliseconds to sleep in between non-write requests to GitHub API.
retryableErrors java.util.List<java.lang.Number> 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 java.lang.Number Amount of time in milliseconds to sleep in between requests to GitHub API after an error response.
token java.lang.String The OAuth token used to connect to GitHub.
writeDelayMs java.lang.Number Amount of time in milliseconds to sleep in between writes to GitHub API.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: java.lang.String

Alias name.

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

appAuthOptional

app_auth block.

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

baseUrlOptional
  • Type: java.lang.String

The GitHub Base API URL.

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

insecureOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable insecure mode for testing purposes.

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

maxRetriesOptional
  • Type: java.lang.Number

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.2.3/docs#max_retries GithubProvider#max_retries}

organizationOptional
  • Type: java.lang.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.2.3/docs#organization GithubProvider#organization}

ownerOptional
  • Type: java.lang.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.2.3/docs#owner GithubProvider#owner}

parallelRequestsOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.2.3/docs#parallel_requests GithubProvider#parallel_requests}

readDelayMsOptional
  • Type: java.lang.Number

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.2.3/docs#read_delay_ms GithubProvider#read_delay_ms}

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

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.2.3/docs#retryable_errors GithubProvider#retryable_errors}

retryDelayMsOptional
  • Type: java.lang.Number

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.2.3/docs#retry_delay_ms GithubProvider#retry_delay_ms}

tokenOptional
  • Type: java.lang.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.2.3/docs#token GithubProvider#token}

writeDelayMsOptional
  • Type: java.lang.Number

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.2.3/docs#write_delay_ms GithubProvider#write_delay_ms}

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 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • 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()
resetInsecure 
public void resetInsecure()
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 CDKTF code for importing a GithubProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.github.provider.GithubProvider;

GithubProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.github.provider.GithubProvider;

GithubProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.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 CDKTF code for importing a GithubProvider resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • 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.2.3/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.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 com.hashicorp.cdktf.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 com.hashicorp.cdktf.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.
insecureInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxRetriesInput java.lang.Number No description.
organizationInput java.lang.String No description.
ownerInput java.lang.String No description.
parallelRequestsInput java.lang.Boolean OR com.hashicorp.cdktf.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.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxRetries java.lang.Number No description.
organization java.lang.String No description.
owner java.lang.String No description.
parallelRequests java.lang.Boolean OR com.hashicorp.cdktf.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.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
appAuthInputOptional 
public GithubProviderAppAuth getAppAuthInput();
baseUrlInputOptional 
public java.lang.String getBaseUrlInput();
  • Type: java.lang.String
insecureInputOptional 
public java.lang.Object getInsecureInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxRetriesInputOptional 
public java.lang.Number getMaxRetriesInput();
  • Type: java.lang.Number
organizationInputOptional 
public java.lang.String getOrganizationInput();
  • Type: java.lang.String
ownerInputOptional 
public java.lang.String getOwnerInput();
  • Type: java.lang.String
parallelRequestsInputOptional 
public java.lang.Object getParallelRequestsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
readDelayMsInputOptional 
public java.lang.Number getReadDelayMsInput();
  • Type: java.lang.Number
retryableErrorsInputOptional 
public java.util.List<java.lang.Number> getRetryableErrorsInput();
  • Type: java.util.List<java.lang.Number>
retryDelayMsInputOptional 
public java.lang.Number getRetryDelayMsInput();
  • Type: java.lang.Number
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
writeDelayMsInputOptional 
public java.lang.Number getWriteDelayMsInput();
  • Type: java.lang.Number
appAuthOptional 
public GithubProviderAppAuth getAppAuth();
baseUrlOptional 
public java.lang.String getBaseUrl();
  • Type: java.lang.String
insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number
organizationOptional 
public java.lang.String getOrganization();
  • Type: java.lang.String
ownerOptional 
public java.lang.String getOwner();
  • Type: java.lang.String
parallelRequestsOptional 
public java.lang.Object getParallelRequests();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
readDelayMsOptional 
public java.lang.Number getReadDelayMs();
  • Type: java.lang.Number
retryableErrorsOptional 
public java.util.List<java.lang.Number> getRetryableErrors();
  • Type: java.util.List<java.lang.Number>
retryDelayMsOptional 
public java.lang.Number getRetryDelayMs();
  • Type: java.lang.Number
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
writeDelayMsOptional 
public java.lang.Number getWriteDelayMs();
  • Type: java.lang.Number

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

GithubProviderAppAuth

Initializer 

import com.hashicorp.cdktf.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 ID.
installationId java.lang.String The GitHub App installation instance ID.
pemFile java.lang.String The GitHub App PEM file contents.
idRequired 
public java.lang.String getId();
  • Type: java.lang.String

The GitHub App ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/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 java.lang.String getInstallationId();
  • Type: java.lang.String

The GitHub App installation instance ID.

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

pemFileRequired 
public java.lang.String getPemFile();
  • Type: java.lang.String

The GitHub App PEM file contents.

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

GithubProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.github.provider.GithubProviderConfig;

GithubProviderConfig.builder()
//  .alias(java.lang.String)
//  .appAuth(GithubProviderAppAuth)
//  .baseUrl(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .maxRetries(java.lang.Number)
//  .organization(java.lang.String)
//  .owner(java.lang.String)
//  .parallelRequests(java.lang.Boolean)
//  .parallelRequests(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 GitHub Base API URL.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable insecure mode for testing purposes.
maxRetries java.lang.Number Number of times to retry a request after receiving an error status codeDefaults to 3.
organization java.lang.String The GitHub organization name to manage. Use this field instead of owner when managing organization accounts.
owner java.lang.String The GitHub owner name to manage. Use this field instead of organization when managing individual accounts.
parallelRequests java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allow the provider to make parallel API calls to GitHub.
readDelayMs java.lang.Number Amount of time in milliseconds to sleep in between non-write requests to GitHub API.
retryableErrors java.util.List<java.lang.Number> 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 java.lang.Number Amount of time in milliseconds to sleep in between requests to GitHub API after an error response.
token java.lang.String The OAuth token used to connect to GitHub.
writeDelayMs java.lang.Number Amount of time in milliseconds to sleep in between writes to GitHub API.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

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

appAuthOptional 
public GithubProviderAppAuth getAppAuth();

app_auth block.

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

baseUrlOptional 
public java.lang.String getBaseUrl();
  • Type: java.lang.String

The GitHub Base API URL.

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

insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable insecure mode for testing purposes.

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

maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number

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.2.3/docs#max_retries GithubProvider#max_retries}

organizationOptional 
public java.lang.String getOrganization();
  • Type: java.lang.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.2.3/docs#organization GithubProvider#organization}

ownerOptional 
public java.lang.String getOwner();
  • Type: java.lang.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.2.3/docs#owner GithubProvider#owner}

parallelRequestsOptional 
public java.lang.Object getParallelRequests();
  • Type: java.lang.Boolean OR com.hashicorp.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.2.3/docs#parallel_requests GithubProvider#parallel_requests}

readDelayMsOptional 
public java.lang.Number getReadDelayMs();
  • Type: java.lang.Number

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.2.3/docs#read_delay_ms GithubProvider#read_delay_ms}

retryableErrorsOptional 
public java.util.List<java.lang.Number> getRetryableErrors();
  • Type: java.util.List<java.lang.Number>

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.2.3/docs#retryable_errors GithubProvider#retryable_errors}

retryDelayMsOptional 
public java.lang.Number getRetryDelayMs();
  • Type: java.lang.Number

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.2.3/docs#retry_delay_ms GithubProvider#retry_delay_ms}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.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.2.3/docs#token GithubProvider#token}

writeDelayMsOptional 
public java.lang.Number getWriteDelayMs();
  • Type: java.lang.Number

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.2.3/docs#write_delay_ms GithubProvider#write_delay_ms}