Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codepipeline
  5. Webhook

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.codepipeline.Webhook

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CodePipeline::Webhook

    Create Webhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
    @overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            authentication: Optional[WebhookAuthentication] = None,
            authentication_configuration: Optional[WebhookAuthConfigurationArgs] = None,
            filters: Optional[Sequence[WebhookFilterRuleArgs]] = None,
            target_action: Optional[str] = None,
            target_pipeline: Optional[str] = None,
            name: Optional[str] = None,
            register_with_third_party: Optional[bool] = None,
            target_pipeline_version: Optional[int] = None)
    func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

    type: aws-native:codepipeline:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Webhook Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Webhook resource accepts the following input properties:

    Authentication Pulumi.AwsNative.CodePipeline.WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration Pulumi.AwsNative.CodePipeline.Inputs.WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters List<Pulumi.AwsNative.CodePipeline.Inputs.WebhookFilterRule>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    TargetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    TargetPipeline string
    The name of the pipeline you want to connect to the webhook.
    Name string
    The name of the webhook
    RegisterWithThirdParty bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    TargetPipelineVersion int
    The version number of the pipeline to be connected to the trigger request.
    Authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration WebhookAuthConfigurationArgs
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters []WebhookFilterRuleArgs
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    TargetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    TargetPipeline string
    The name of the pipeline you want to connect to the webhook.
    Name string
    The name of the webhook
    RegisterWithThirdParty bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    TargetPipelineVersion int
    The version number of the pipeline to be connected to the trigger request.
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters List<WebhookFilterRule>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    targetAction String
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline String
    The name of the pipeline you want to connect to the webhook.
    name String
    The name of the webhook
    registerWithThirdParty Boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    targetPipelineVersion Integer
    The version number of the pipeline to be connected to the trigger request.
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters WebhookFilterRule[]
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    targetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline string
    The name of the pipeline you want to connect to the webhook.
    name string
    The name of the webhook
    registerWithThirdParty boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    targetPipelineVersion number
    The version number of the pipeline to be connected to the trigger request.
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authentication_configuration WebhookAuthConfigurationArgs
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters Sequence[WebhookFilterRuleArgs]
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    target_action str
    The name of the action in a pipeline you want to connect to the webhook.
    target_pipeline str
    The name of the pipeline you want to connect to the webhook.
    name str
    The name of the webhook
    register_with_third_party bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    target_pipeline_version int
    The version number of the pipeline to be connected to the trigger request.
    authentication "GITHUB_HMAC" | "IP" | "UNAUTHENTICATED"
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration Property Map
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters List<Property Map>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    targetAction String
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline String
    The name of the pipeline you want to connect to the webhook.
    name String
    The name of the webhook
    registerWithThirdParty Boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    targetPipelineVersion Number
    The version number of the pipeline to be connected to the trigger request.

    Outputs

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

    AwsId string
    logical id of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The webhook URL generated by AWS CodePipeline
    AwsId string
    logical id of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The webhook URL generated by AWS CodePipeline
    awsId String
    logical id of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The webhook URL generated by AWS CodePipeline
    awsId string
    logical id of the webhook
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The webhook URL generated by AWS CodePipeline
    aws_id str
    logical id of the webhook
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The webhook URL generated by AWS CodePipeline
    awsId String
    logical id of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The webhook URL generated by AWS CodePipeline

    Supporting Types

    WebhookAuthConfiguration, WebhookAuthConfigurationArgs

    AllowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    SecretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    AllowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    SecretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange String
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken String
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowed_ip_range str
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secret_token str
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange String
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken String
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

    WebhookAuthentication, WebhookAuthenticationArgs

    GithubHmac
    GITHUB_HMAC
    Ip
    IP
    Unauthenticated
    UNAUTHENTICATED
    WebhookAuthenticationGithubHmac
    GITHUB_HMAC
    WebhookAuthenticationIp
    IP
    WebhookAuthenticationUnauthenticated
    UNAUTHENTICATED
    GithubHmac
    GITHUB_HMAC
    Ip
    IP
    Unauthenticated
    UNAUTHENTICATED
    GithubHmac
    GITHUB_HMAC
    Ip
    IP
    Unauthenticated
    UNAUTHENTICATED
    GITHUB_HMAC
    GITHUB_HMAC
    IP
    IP
    UNAUTHENTICATED
    UNAUTHENTICATED
    "GITHUB_HMAC"
    GITHUB_HMAC
    "IP"
    IP
    "UNAUTHENTICATED"
    UNAUTHENTICATED

    WebhookFilterRule, WebhookFilterRuleArgs

    JsonPath string
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    MatchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    JsonPath string
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    MatchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath String
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    matchEquals String
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath string
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    matchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    json_path str
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    match_equals str
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath String
    A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored.
    matchEquals String
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
    pulumi/pulumi-aws-native