pulumi-infisical
Version:
A Pulumi provider for managing Infisical secrets management platform, dynamically bridged from the Terraform Infisical provider with support for projects, secrets, identity management, integrations, and access controls.
133 lines • 5.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class Webhook extends pulumi.CustomResource {
/**
* Get an existing Webhook 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WebhookState, opts?: pulumi.CustomResourceOptions): Webhook;
/**
* Returns true if the given object is an instance of Webhook. 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 Webhook;
/**
* The slug of the environment the webhook listens to.
*/
readonly environment: pulumi.Output<string>;
/**
* The events that trigger the webhook. Options: secrets.modified, secrets.rotation-failed. An empty set means the webhook fires on every supported event.
*/
readonly eventsFilters: pulumi.Output<string[]>;
/**
* Whether the webhook is disabled. Defaults to false.
*/
readonly isDisabled: pulumi.Output<boolean>;
/**
* The ID of the project the webhook belongs to.
*/
readonly projectId: pulumi.Output<string>;
/**
* The secret path the webhook listens to. Defaults to '/'.
*/
readonly secretPath: pulumi.Output<string>;
/**
* The webhook type. Options: general, slack, microsoft-teams. Defaults to 'general'.
*/
readonly type: pulumi.Output<string>;
/**
* The secret key used to sign the webhook payload so the receiver can verify it. Write-only: it is never returned by the API, so it cannot be imported.
*/
readonly webhookSecretKey: pulumi.Output<string | undefined>;
/**
* The URL Infisical sends the event payload to.
*/
readonly webhookUrl: pulumi.Output<string>;
/**
* Create a Webhook 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: WebhookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Webhook resources.
*/
export interface WebhookState {
/**
* The slug of the environment the webhook listens to.
*/
environment?: pulumi.Input<string | undefined>;
/**
* The events that trigger the webhook. Options: secrets.modified, secrets.rotation-failed. An empty set means the webhook fires on every supported event.
*/
eventsFilters?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Whether the webhook is disabled. Defaults to false.
*/
isDisabled?: pulumi.Input<boolean | undefined>;
/**
* The ID of the project the webhook belongs to.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The secret path the webhook listens to. Defaults to '/'.
*/
secretPath?: pulumi.Input<string | undefined>;
/**
* The webhook type. Options: general, slack, microsoft-teams. Defaults to 'general'.
*/
type?: pulumi.Input<string | undefined>;
/**
* The secret key used to sign the webhook payload so the receiver can verify it. Write-only: it is never returned by the API, so it cannot be imported.
*/
webhookSecretKey?: pulumi.Input<string | undefined>;
/**
* The URL Infisical sends the event payload to.
*/
webhookUrl?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Webhook resource.
*/
export interface WebhookArgs {
/**
* The slug of the environment the webhook listens to.
*/
environment: pulumi.Input<string>;
/**
* The events that trigger the webhook. Options: secrets.modified, secrets.rotation-failed. An empty set means the webhook fires on every supported event.
*/
eventsFilters?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Whether the webhook is disabled. Defaults to false.
*/
isDisabled?: pulumi.Input<boolean | undefined>;
/**
* The ID of the project the webhook belongs to.
*/
projectId: pulumi.Input<string>;
/**
* The secret path the webhook listens to. Defaults to '/'.
*/
secretPath?: pulumi.Input<string | undefined>;
/**
* The webhook type. Options: general, slack, microsoft-teams. Defaults to 'general'.
*/
type?: pulumi.Input<string | undefined>;
/**
* The secret key used to sign the webhook payload so the receiver can verify it. Write-only: it is never returned by the API, so it cannot be imported.
*/
webhookSecretKey?: pulumi.Input<string | undefined>;
/**
* The URL Infisical sends the event payload to.
*/
webhookUrl: pulumi.Input<string>;
}
//# sourceMappingURL=webhook.d.ts.map