@pulumi/pulumiservice
Version:
[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io
98 lines • 4.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a new custom VCS integration for an organization. Custom VCS integrations allow connecting self-hosted or third-party version control systems (e.g. Gitea, Forgejo, Bitbucket Server) to Pulumi Deployments. Credentials are managed via ESC environments, and deployments are triggered by inbound webhooks. Returns the created integration including its webhook URL and HMAC secret for signature verification.
*/
export declare class CustomVCSIntegration extends pulumi.CustomResource {
/**
* Get an existing CustomVCSIntegration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CustomVCSIntegration;
/**
* Returns true if the given object is an instance of CustomVCSIntegration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CustomVCSIntegration;
/**
* URL prefix for repositories covered by this integration
*/
readonly baseUrl: pulumi.Output<string>;
/**
* ISO 8601 timestamp of when the integration was created
*/
readonly created: pulumi.Output<string>;
/**
* ESC environment reference in 'project/envName' format containing VCS credentials
*/
readonly environment: pulumi.Output<string>;
/**
* Unique identifier (UUID) for this integration
*/
readonly integrationId: pulumi.Output<string>;
/**
* ISO 8601 timestamp of when the integration was last modified
*/
readonly modified: pulumi.Output<string>;
/**
* Human-readable name for the integration
*/
readonly name: pulumi.Output<string>;
/**
* List of repositories configured on this integration
*/
readonly repositories: pulumi.Output<any[] | undefined>;
/**
* Version control system type
*/
readonly vcsType: pulumi.Output<string>;
/**
* HMAC secret for webhook signature verification. Only returned on integration creation; subsequent GET requests omit this field.
*/
readonly webhookSecret: pulumi.Output<string | undefined>;
/**
* Full webhook endpoint URL that the external VCS should POST events to. This URL is generated by the service and includes the integration ID.
*/
readonly webhookUrl: pulumi.Output<string | undefined>;
/**
* Create a CustomVCSIntegration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CustomVCSIntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CustomVCSIntegration resource.
*/
export interface CustomVCSIntegrationArgs {
/**
* URL prefix for repositories covered by this integration (e.g. 'https://gitea.example.com/myorg'). Used to match repositories to integrations.
*/
baseUrl: pulumi.Input<string>;
/**
* ESC environment reference in 'project/envName' format containing VCS credentials (e.g. SSH keys, access tokens) used for repository operations
*/
environment: pulumi.Input<string>;
/**
* The custom VCS integration identifier
*/
integrationId?: pulumi.Input<string | undefined>;
/**
* Human-readable name for the integration, unique within the organization (e.g. 'Gitea Production')
*/
name: pulumi.Input<string>;
/**
* The organization name
*/
orgName: pulumi.Input<string>;
/**
* Version control system type. Defaults to 'git' if not specified.
*/
vcsType?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=customVCSIntegration.d.ts.map