published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
Beta. Manages an existing Dokploy GitHub integration after setup and authorization in Dokploy; import-only.
Create GitHubIntegration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GitHubIntegration(name: string, args: GitHubIntegrationArgs, opts?: CustomResourceOptions);@overload
def GitHubIntegration(resource_name: str,
args: GitHubIntegrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GitHubIntegration(resource_name: str,
opts: Optional[ResourceOptions] = None,
github_app_name: Optional[str] = None,
name: Optional[str] = None)func NewGitHubIntegration(ctx *Context, name string, args GitHubIntegrationArgs, opts ...ResourceOption) (*GitHubIntegration, error)public GitHubIntegration(string name, GitHubIntegrationArgs args, CustomResourceOptions? opts = null)
public GitHubIntegration(String name, GitHubIntegrationArgs args)
public GitHubIntegration(String name, GitHubIntegrationArgs args, CustomResourceOptions options)
type: dokploy:GitHubIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_git_hub_integration" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GitHubIntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GitHubIntegrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GitHubIntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GitHubIntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GitHubIntegrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gitHubIntegrationResource = new Dokploy.GitHubIntegration("gitHubIntegrationResource", new()
{
GithubAppName = "string",
Name = "string",
});
example, err := dokploy.NewGitHubIntegration(ctx, "gitHubIntegrationResource", &dokploy.GitHubIntegrationArgs{
GithubAppName: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "dokploy_git_hub_integration" "gitHubIntegrationResource" {
lifecycle {
create_before_destroy = true
}
github_app_name = "string"
name = "string"
}
var gitHubIntegrationResource = new GitHubIntegration("gitHubIntegrationResource", GitHubIntegrationArgs.builder()
.githubAppName("string")
.name("string")
.build());
git_hub_integration_resource = dokploy.GitHubIntegration("gitHubIntegrationResource",
github_app_name="string",
name="string")
const gitHubIntegrationResource = new dokploy.GitHubIntegration("gitHubIntegrationResource", {
githubAppName: "string",
name: "string",
});
type: dokploy:GitHubIntegration
properties:
githubAppName: string
name: string
GitHubIntegration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GitHubIntegration resource accepts the following input properties:
- Github
App stringName - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- Name string
- The required Dokploy integration display name.
- Github
App stringName - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- Name string
- The required Dokploy integration display name.
- github_
app_ stringname - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- name string
- The required Dokploy integration display name.
- github
App StringName - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- name String
- The required Dokploy integration display name.
- github
App stringName - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- name string
- The required Dokploy integration display name.
- github_
app_ strname - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- name str
- The required Dokploy integration display name.
- github
App StringName - The GitHub App name stored by Dokploy; this does not configure the GitHub-side App.
- name String
- The required Dokploy integration display name.
Outputs
All input properties are implicitly available as output properties. Additionally, the GitHubIntegration resource produces the following output properties:
- Git
Provider stringId - The stable Dokploy Git-provider parent ID.
- Github
Id string - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The owning Dokploy organization ID.
- Git
Provider stringId - The stable Dokploy Git-provider parent ID.
- Github
Id string - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The owning Dokploy organization ID.
- git_
provider_ stringid - The stable Dokploy Git-provider parent ID.
- github_
id string - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- id string
- The provider-assigned unique ID for this managed resource.
- organization_
id string - The owning Dokploy organization ID.
- git
Provider StringId - The stable Dokploy Git-provider parent ID.
- github
Id String - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The owning Dokploy organization ID.
- git
Provider stringId - The stable Dokploy Git-provider parent ID.
- github
Id string - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- id string
- The provider-assigned unique ID for this managed resource.
- organization
Id string - The owning Dokploy organization ID.
- git_
provider_ strid - The stable Dokploy Git-provider parent ID.
- github_
id str - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- id str
- The provider-assigned unique ID for this managed resource.
- organization_
id str - The owning Dokploy organization ID.
- git
Provider StringId - The stable Dokploy Git-provider parent ID.
- github
Id String - The stable Dokploy GitHub relation ID used as the Pulumi resource identity.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The owning Dokploy organization ID.
Look up Existing GitHubIntegration Resource
Get an existing GitHubIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): GitHubIntegration@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> GitHubIntegrationfunc GetGitHubIntegration(ctx *Context, name string, id IDInput, state *GitHubIntegrationState, opts ...ResourceOption) (*GitHubIntegration, error)public static GitHubIntegration Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static GitHubIntegration get(String name, Output<String> id, CustomResourceOptions options)resources: existingGitHubIntegration: type: dokploy:GitHubIntegration get: id: ${id}import {
to = dokploy_git_hub_integration.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GitHubIntegrationState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
published on Thursday, Nov 5, 2026 by dimeskigj