Package software.amazon.awscdk.mixins.preview.services.codepipeline.mixins

Class CfnWebhookPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.codepipeline.mixins.CfnWebhookPropsMixin
All Implemented Interfaces:
IMixin, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:24.127Z") @Stability(Stable) public class CfnWebhookPropsMixin extends Mixin implements IMixin
The AWS::CodePipeline::Webhook resource creates and registers your webhook.

After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Migrate polling pipelines to use event-based change detection in the AWS CodePipeline User Guide .

We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see Using Dynamic References to Specify Template Values .

When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.codepipeline.mixins.*;
 CfnWebhookPropsMixin cfnWebhookPropsMixin = CfnWebhookPropsMixin.Builder.create(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())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnWebhookPropsMixin

      protected CfnWebhookPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWebhookPropsMixin

      protected CfnWebhookPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWebhookPropsMixin

      @Stability(Stable) public CfnWebhookPropsMixin(@NotNull CfnWebhookMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CodePipeline::Webhook.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnWebhookPropsMixin

      @Stability(Stable) public CfnWebhookPropsMixin(@NotNull CfnWebhookMixinProps props)
      Create a mixin to apply properties to AWS::CodePipeline::Webhook.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) @NotNull public software.constructs.IConstruct applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnWebhookMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected PropertyMergeStrategy getStrategy()