Package software.amazon.awscdk.services.codepipeline

Class CfnWebhook.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.CfnWebhook.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebhook>
Enclosing class:
CfnWebhook
@Stability(Stable) public static final class CfnWebhook.Builder extends Object implements software.amazon.jsii.Builder<CfnWebhook>
A fluent builder for CfnWebhook.

  • Method Details

    • create

      @Stability(Stable) public static CfnWebhook.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnWebhook.Builder.

    • authentication

      @Stability(Stable) public CfnWebhook.Builder authentication(String authentication)
      Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

      • 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.

      Parameters:
      authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. This parameter is required.
      Returns:
      this

    • authenticationConfiguration

      @Stability(Stable) public CfnWebhook.Builder authenticationConfiguration(IResolvable authenticationConfiguration)
      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.

      Parameters:
      authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. This parameter is required.
      Returns:
      this

    • authenticationConfiguration

      @Stability(Stable) public CfnWebhook.Builder authenticationConfiguration(CfnWebhook.WebhookAuthConfigurationProperty authenticationConfiguration)
      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.

      Parameters:
      authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. This parameter is required.
      Returns:
      this

    • filters

      @Stability(Stable) public CfnWebhook.Builder filters(IResolvable filters)
      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.

      Parameters:
      filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. This parameter is required.
      Returns:
      this

    • filters

      @Stability(Stable) public CfnWebhook.Builder filters(List<? extends Object> filters)
      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.

      Parameters:
      filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. This parameter is required.
      Returns:
      this

    • targetAction

      @Stability(Stable) public CfnWebhook.Builder targetAction(String targetAction)
      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.

      Parameters:
      targetAction - The name of the action in a pipeline you want to connect to the webhook. This parameter is required.
      Returns:
      this

    • targetPipeline

      @Stability(Stable) public CfnWebhook.Builder targetPipeline(String targetPipeline)
      The name of the pipeline you want to connect to the webhook.

      Parameters:
      targetPipeline - The name of the pipeline you want to connect to the webhook. This parameter is required.
      Returns:
      this

    • targetPipelineVersion

      @Stability(Stable) public CfnWebhook.Builder targetPipelineVersion(Number targetPipelineVersion)
      The version number of the pipeline to be connected to the trigger request.

      Required: Yes

      Type: Integer

      Update requires: No interruption

      Parameters:
      targetPipelineVersion - The version number of the pipeline to be connected to the trigger request. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnWebhook.Builder name(String name)
      The name of the webhook.

      Parameters:
      name - The name of the webhook. This parameter is required.
      Returns:
      this

    • registerWithThirdParty

      @Stability(Stable) public CfnWebhook.Builder registerWithThirdParty(Boolean registerWithThirdParty)
      Configures a connection between the webhook that was created and the external tool with events to be detected.

      Parameters:
      registerWithThirdParty - Configures a connection between the webhook that was created and the external tool with events to be detected. This parameter is required.
      Returns:
      this

    • registerWithThirdParty

      @Stability(Stable) public CfnWebhook.Builder registerWithThirdParty(IResolvable registerWithThirdParty)
      Configures a connection between the webhook that was created and the external tool with events to be detected.

      Parameters:
      registerWithThirdParty - Configures a connection between the webhook that was created and the external tool with events to be detected. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnWebhook build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnWebhook>
      Returns:
      a newly built instance of CfnWebhook.