Google Cloud Native v0.30.0, Apr 14 23

google-native.cloudbuild/v1.GithubEnterpriseConfig

Explore with Pulumi AI

Create an association between a GCP project and a GitHub Enterprise server.

Create GithubEnterpriseConfig Resource

new GithubEnterpriseConfig(name: string, args: GithubEnterpriseConfigArgs, opts?: CustomResourceOptions);

@overload
def GithubEnterpriseConfig(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           app_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           ghe_config_id: Optional[str] = None,
                           host_url: Optional[str] = None,
                           location: Optional[str] = None,
                           name: Optional[str] = None,
                           peered_network: Optional[str] = None,
                           project: Optional[str] = None,
                           project_id: Optional[str] = None,
                           secrets: Optional[GitHubEnterpriseSecretsArgs] = None,
                           ssl_ca: Optional[str] = None,
                           webhook_key: Optional[str] = None)
@overload
def GithubEnterpriseConfig(resource_name: str,
                           args: GithubEnterpriseConfigArgs,
                           opts: Optional[ResourceOptions] = None)

func NewGithubEnterpriseConfig(ctx *Context, name string, args GithubEnterpriseConfigArgs, opts ...ResourceOption) (*GithubEnterpriseConfig, error)

public GithubEnterpriseConfig(string name, GithubEnterpriseConfigArgs args, CustomResourceOptions? opts = null)

public GithubEnterpriseConfig(String name, GithubEnterpriseConfigArgs args)
public GithubEnterpriseConfig(String name, GithubEnterpriseConfigArgs args, CustomResourceOptions options)

type: google-native:cloudbuild/v1:GithubEnterpriseConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GithubEnterpriseConfigArgs: 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 GithubEnterpriseConfigArgs: 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 GithubEnterpriseConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GithubEnterpriseConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GithubEnterpriseConfigArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

GithubEnterpriseConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The GithubEnterpriseConfig resource accepts the following input properties:

AppId string: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
DisplayName string: Name to display for this config.
GheConfigId string: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
HostUrl string: The URL of the github enterprise host the configuration is for.
Location string
Name string: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
PeeredNetwork string: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
Project string
ProjectId string: ID of the project.
Secrets Pulumi.GoogleNative.CloudBuild.V1.Inputs.GitHubEnterpriseSecretsArgs: Names of secrets in Secret Manager.
SslCa string: Optional. SSL certificate to use for requests to GitHub Enterprise.
WebhookKey string: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

AppId string: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
DisplayName string: Name to display for this config.
GheConfigId string: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
HostUrl string: The URL of the github enterprise host the configuration is for.
Location string
Name string: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
PeeredNetwork string: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
Project string
ProjectId string: ID of the project.
Secrets GitHubEnterpriseSecretsArgs: Names of secrets in Secret Manager.
SslCa string: Optional. SSL certificate to use for requests to GitHub Enterprise.
WebhookKey string: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

appId String: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
displayName String: Name to display for this config.
gheConfigId String: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
hostUrl String: The URL of the github enterprise host the configuration is for.
location String
name String: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork String: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
project String
projectId String: ID of the project.
secrets GitHubEnterpriseSecretsArgs: Names of secrets in Secret Manager.
sslCa String: Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey String: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

appId string: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
displayName string: Name to display for this config.
gheConfigId string: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
hostUrl string: The URL of the github enterprise host the configuration is for.
location string
name string: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork string: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
project string
projectId string: ID of the project.
secrets GitHubEnterpriseSecretsArgs: Names of secrets in Secret Manager.
sslCa string: Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey string: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

app_id str: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
display_name str: Name to display for this config.
ghe_config_id str: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
host_url str: The URL of the github enterprise host the configuration is for.
location str
name str: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peered_network str: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
project str
project_id str: ID of the project.
secrets GitHubEnterpriseSecretsArgs: Names of secrets in Secret Manager.
ssl_ca str: Optional. SSL certificate to use for requests to GitHub Enterprise.
webhook_key str: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

appId String: The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
displayName String: Name to display for this config.
gheConfigId String: Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
hostUrl String: The URL of the github enterprise host the configuration is for.
location String
name String: Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
peeredNetwork String: Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
project String
projectId String: ID of the project.
secrets Property Map: Names of secrets in Secret Manager.
sslCa String: Optional. SSL certificate to use for requests to GitHub Enterprise.
webhookKey String: The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

Outputs

All input properties are implicitly available as output properties. Additionally, the GithubEnterpriseConfig resource produces the following output properties:

CreateTime string: Time when the installation was associated with the project.
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: Time when the installation was associated with the project.
Id string: The provider-assigned unique ID for this managed resource.

createTime String: Time when the installation was associated with the project.
id String: The provider-assigned unique ID for this managed resource.

createTime string: Time when the installation was associated with the project.
id string: The provider-assigned unique ID for this managed resource.

create_time str: Time when the installation was associated with the project.
id str: The provider-assigned unique ID for this managed resource.

createTime String: Time when the installation was associated with the project.
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GitHubEnterpriseSecrets

OauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName string: The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName string: The resource name for the private key secret.
PrivateKeyVersionName string: The resource name for the private key secret version.
WebhookSecretName string: The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

OauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName string: The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName string: The resource name for the private key secret.
PrivateKeyVersionName string: The resource name for the private key secret version.
WebhookSecretName string: The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName String: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName String: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName String: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName String: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName String: The resource name for the private key secret.
privateKeyVersionName String: The resource name for the private key secret version.
webhookSecretName String: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName String: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName string: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName string: The resource name for the private key secret.
privateKeyVersionName string: The resource name for the private key secret version.
webhookSecretName string: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

oauth_client_id_name str: The resource name for the OAuth client ID secret in Secret Manager.
oauth_client_id_version_name str: The resource name for the OAuth client ID secret version in Secret Manager.
oauth_secret_name str: The resource name for the OAuth secret in Secret Manager.
oauth_secret_version_name str: The resource name for the OAuth secret secret version in Secret Manager.
private_key_name str: The resource name for the private key secret.
private_key_version_name str: The resource name for the private key secret version.
webhook_secret_name str: The resource name for the webhook secret in Secret Manager.
webhook_secret_version_name str: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName String: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName String: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName String: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName String: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName String: The resource name for the private key secret.
privateKeyVersionName String: The resource name for the private key secret version.
webhookSecretName String: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName String: The resource name for the webhook secret secret version in Secret Manager.

GitHubEnterpriseSecretsResponse

OauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName string: The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName string: The resource name for the private key secret.
PrivateKeyVersionName string: The resource name for the private key secret version.
WebhookSecretName string: The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

OauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
OauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
OauthSecretName string: The resource name for the OAuth secret in Secret Manager.
OauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
PrivateKeyName string: The resource name for the private key secret.
PrivateKeyVersionName string: The resource name for the private key secret version.
WebhookSecretName string: The resource name for the webhook secret in Secret Manager.
WebhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName String: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName String: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName String: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName String: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName String: The resource name for the private key secret.
privateKeyVersionName String: The resource name for the private key secret version.
webhookSecretName String: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName String: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName string: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName string: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName string: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName string: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName string: The resource name for the private key secret.
privateKeyVersionName string: The resource name for the private key secret version.
webhookSecretName string: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName string: The resource name for the webhook secret secret version in Secret Manager.

oauth_client_id_name str: The resource name for the OAuth client ID secret in Secret Manager.
oauth_client_id_version_name str: The resource name for the OAuth client ID secret version in Secret Manager.
oauth_secret_name str: The resource name for the OAuth secret in Secret Manager.
oauth_secret_version_name str: The resource name for the OAuth secret secret version in Secret Manager.
private_key_name str: The resource name for the private key secret.
private_key_version_name str: The resource name for the private key secret version.
webhook_secret_name str: The resource name for the webhook secret in Secret Manager.
webhook_secret_version_name str: The resource name for the webhook secret secret version in Secret Manager.

oauthClientIdName String: The resource name for the OAuth client ID secret in Secret Manager.
oauthClientIdVersionName String: The resource name for the OAuth client ID secret version in Secret Manager.
oauthSecretName String: The resource name for the OAuth secret in Secret Manager.
oauthSecretVersionName String: The resource name for the OAuth secret secret version in Secret Manager.
privateKeyName String: The resource name for the private key secret.
privateKeyVersionName String: The resource name for the private key secret version.
webhookSecretName String: The resource name for the webhook secret in Secret Manager.
webhookSecretVersionName String: The resource name for the webhook secret secret version in Secret Manager.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0