Package software.amazon.awscdk.cfnpropertymixins.services.codepipeline

Interface CfnWebhookMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebhookMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.343Z")
@Stability(Stable)
public interface CfnWebhookMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnWebhookPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.codepipeline.*;
 CfnWebhookMixinProps cfnWebhookMixinProps = CfnWebhookMixinProps.builder()
         .authentication("authentication")
         .authenticationConfiguration(WebhookAuthConfigurationProperty.builder()
                 .allowedIpRange("allowedIpRange")
                 .secretToken("secretToken")
                 .build())
         .filters(List.of(WebhookFilterRuleProperty.builder()
                 .jsonPath("jsonPath")
                 .matchEquals("matchEquals")
                 .build()))
         .name("name")
         .registerWithThirdParty(false)
         .targetAction("targetAction")
         .targetPipeline("targetPipeline")
         .targetPipelineVersion(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebhookMixinProps.Builder	A builder for CfnWebhookMixinProps
static final class	CfnWebhookMixinProps.Jsii$Proxy	An implementation for CfnWebhookMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnWebhookMixinProps.Builder	builder()
default String	getAuthentication()	Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
default Object	getAuthenticationConfiguration()	Properties that configure the authentication applied to incoming webhook trigger requests.
default Object	getFilters()	A list of rules applied to the body/payload sent in the POST request to a webhook URL.
default String	getName()	The name of the webhook.
default Object	getRegisterWithThirdParty()	Configures a connection between the webhook that was created and the external tool with events to be detected.
default String	getTargetAction()	The name of the action in a pipeline you want to connect to the webhook.
default String	getTargetPipeline()	The name of the pipeline you want to connect to the webhook.
default Number	getTargetPipelineVersion()	The version number of the pipeline to be connected to the trigger request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthentication

@Stability(Stable)
@Nullable
default String getAuthentication()

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. > If a secret token was provided, it will be redacted in the response.

• For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication

getAuthenticationConfiguration

@Stability(Stable)
@Nullable
default Object getAuthenticationConfiguration()

Properties that configure the authentication applied to incoming webhook trigger requests.

The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Returns union: either IResolvable or CfnWebhookPropsMixin.WebhookAuthConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration

getFilters

@Stability(Stable)
@Nullable
default Object getFilters()

A list of rules applied to the body/payload sent in the POST request to a webhook URL.

All defined rules must pass for the request to be accepted and the pipeline started.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWebhookPropsMixin.WebhookFilterRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the webhook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name

getRegisterWithThirdParty

@Stability(Stable)
@Nullable
default Object getRegisterWithThirdParty()

Configures a connection between the webhook that was created and the external tool with events to be detected.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty

getTargetAction

@Stability(Stable)
@Nullable
default String getTargetAction()

The name of the action in a pipeline you want to connect to the webhook.

The action must be from the source (first) stage of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction

getTargetPipeline

@Stability(Stable)
@Nullable
default String getTargetPipeline()

The name of the pipeline you want to connect to the webhook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline

getTargetPipelineVersion

@Stability(Stable)
@Nullable
default Number getTargetPipelineVersion()

The version number of the pipeline to be connected to the trigger request.

Required: Yes

Type: Integer

Update requires: No interruption

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion

builder

@Stability(Stable)
static CfnWebhookMixinProps.Builder builder()

Returns:

a CfnWebhookMixinProps.Builder of CfnWebhookMixinProps