@pulumi/aws-native/codepipeline/webhook.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Resource Type definition for AWS::CodePipeline::Webhook
 */
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 opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, 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;
    /**
     * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
     */
    readonly authentication: pulumi.Output<enums.codepipeline.WebhookAuthentication>;
    /**
     * Properties that configure the authentication applied to incoming webhook trigger requests
     */
    readonly authenticationConfiguration: pulumi.Output<outputs.codepipeline.WebhookAuthConfiguration>;
    /**
     * logical id of the webhook
     */
    readonly awsId: pulumi.Output<string>;
    /**
     * A list of rules applied to the body/payload sent in the POST request to a webhook URL
     */
    readonly filters: pulumi.Output<outputs.codepipeline.WebhookFilterRule[]>;
    /**
     * The name of the webhook
     */
    readonly name: pulumi.Output<string | undefined>;
    /**
     * Configures a connection between the webhook that was created and the external tool with events to be detected.
     */
    readonly registerWithThirdParty: pulumi.Output<boolean | undefined>;
    /**
     * The name of the action in a pipeline you want to connect to the webhook.
     */
    readonly targetAction: pulumi.Output<string>;
    /**
     * The name of the pipeline you want to connect to the webhook.
     */
    readonly targetPipeline: pulumi.Output<string>;
    /**
     * The version number of the pipeline to be connected to the trigger request.
     */
    readonly targetPipelineVersion: pulumi.Output<number | undefined>;
    /**
     * The webhook URL generated by AWS CodePipeline
     */
    readonly url: 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);
}
/**
 * The set of arguments for constructing a Webhook resource.
 */
export interface WebhookArgs {
    /**
     * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
     */
    authentication: pulumi.Input<enums.codepipeline.WebhookAuthentication>;
    /**
     * Properties that configure the authentication applied to incoming webhook trigger requests
     */
    authenticationConfiguration: pulumi.Input<inputs.codepipeline.WebhookAuthConfigurationArgs>;
    /**
     * A list of rules applied to the body/payload sent in the POST request to a webhook URL
     */
    filters: pulumi.Input<pulumi.Input<inputs.codepipeline.WebhookFilterRuleArgs>[]>;
    /**
     * The name of the webhook
     */
    name?: pulumi.Input<string>;
    /**
     * Configures a connection between the webhook that was created and the external tool with events to be detected.
     */
    registerWithThirdParty?: pulumi.Input<boolean>;
    /**
     * The name of the action in a pipeline you want to connect to the webhook.
     */
    targetAction: pulumi.Input<string>;
    /**
     * The name of the pipeline you want to connect to the webhook.
     */
    targetPipeline: pulumi.Input<string>;
    /**
     * The version number of the pipeline to be connected to the trigger request.
     */
    targetPipelineVersion?: pulumi.Input<number>;
}