@pulumi/gcp/securesourcemanager/hook.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Hook is a user-defined HTTP callback triggered by an event.
 *
 * To get more information about Hook, see:
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/secure-source-manager/docs/overview)
 *
 * ## Example Usage
 *
 * ## Import
 *
 * Hook can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/hooks/{{hook_id}}`
 * * `{{project}}/{{location}}/{{repository_id}}/{{hook_id}}`
 * * `{{location}}/{{repository_id}}/{{hook_id}}`
 * * `{{hook_id}}`
 *
 * When using the `pulumi import` command, Hook can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:securesourcemanager/hook:Hook default projects/{{project}}/locations/{{location}}/repositories/{{repository_id}}/hooks/{{hook_id}}
 * $ pulumi import gcp:securesourcemanager/hook:Hook default {{project}}/{{location}}/{{repository_id}}/{{hook_id}}
 * $ pulumi import gcp:securesourcemanager/hook:Hook default {{location}}/{{repository_id}}/{{hook_id}}
 * $ pulumi import gcp:securesourcemanager/hook:Hook default {{hook_id}}
 * ```
 */
export declare class Hook extends pulumi.CustomResource {
    /**
     * Get an existing Hook 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?: HookState, opts?: pulumi.CustomResourceOptions): Hook;
    /**
     * Returns true if the given object is an instance of Hook.  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 Hook;
    /**
     * Create timestamp.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * Determines if the hook disabled or not.
     * Set to true to stop sending traffic.
     */
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * The events that trigger hook on.
     * Each value may be one of: `PUSH`, `PULL_REQUEST`.
     */
    readonly events: pulumi.Output<string[]>;
    /**
     * The ID for the Hook.
     */
    readonly hookId: pulumi.Output<string>;
    /**
     * The location for the Repository.
     */
    readonly location: pulumi.Output<string>;
    /**
     * A unique identifier for a Hook. The name should be of the format:
     * `projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}`
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The trigger option for push events.
     * Structure is documented below.
     */
    readonly pushOption: pulumi.Output<outputs.securesourcemanager.HookPushOption>;
    /**
     * The ID for the Repository.
     */
    readonly repositoryId: pulumi.Output<string>;
    /**
     * The sensitive query string to be appended to the target URI.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    readonly sensitiveQueryString: pulumi.Output<string | undefined>;
    /**
     * The target URI to which the payloads will be delivered.
     */
    readonly targetUri: pulumi.Output<string>;
    /**
     * Unique identifier of the hook.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * Update timestamp.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a Hook 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: HookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Hook resources.
 */
export interface HookState {
    /**
     * Create timestamp.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Determines if the hook disabled or not.
     * Set to true to stop sending traffic.
     */
    disabled?: pulumi.Input<boolean | undefined>;
    /**
     * The events that trigger hook on.
     * Each value may be one of: `PUSH`, `PULL_REQUEST`.
     */
    events?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID for the Hook.
     */
    hookId?: pulumi.Input<string | undefined>;
    /**
     * The location for the Repository.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * A unique identifier for a Hook. The name should be of the format:
     * `projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}`
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The trigger option for push events.
     * Structure is documented below.
     */
    pushOption?: pulumi.Input<inputs.securesourcemanager.HookPushOption | undefined>;
    /**
     * The ID for the Repository.
     */
    repositoryId?: pulumi.Input<string | undefined>;
    /**
     * The sensitive query string to be appended to the target URI.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    sensitiveQueryString?: pulumi.Input<string | undefined>;
    /**
     * The target URI to which the payloads will be delivered.
     */
    targetUri?: pulumi.Input<string | undefined>;
    /**
     * Unique identifier of the hook.
     */
    uid?: pulumi.Input<string | undefined>;
    /**
     * Update timestamp.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Hook resource.
 */
export interface HookArgs {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Determines if the hook disabled or not.
     * Set to true to stop sending traffic.
     */
    disabled?: pulumi.Input<boolean | undefined>;
    /**
     * The events that trigger hook on.
     * Each value may be one of: `PUSH`, `PULL_REQUEST`.
     */
    events?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID for the Hook.
     */
    hookId: pulumi.Input<string>;
    /**
     * The location for the Repository.
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The trigger option for push events.
     * Structure is documented below.
     */
    pushOption?: pulumi.Input<inputs.securesourcemanager.HookPushOption | undefined>;
    /**
     * The ID for the Repository.
     */
    repositoryId: pulumi.Input<string>;
    /**
     * The sensitive query string to be appended to the target URI.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    sensitiveQueryString?: pulumi.Input<string | undefined>;
    /**
     * The target URI to which the payloads will be delivered.
     */
    targetUri: pulumi.Input<string>;
}
//# sourceMappingURL=hook.d.ts.map