Package software.amazon.awscdk.services.codepipeline

Interface CfnWebhookProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebhookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.294Z")
@Stability(Stable)
public interface CfnWebhookProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWebhook.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 CfnWebhookProps cfnWebhookProps = CfnWebhookProps.builder()
         .authentication("authentication")
         .authenticationConfiguration(WebhookAuthConfigurationProperty.builder()
                 .allowedIpRange("allowedIpRange")
                 .secretToken("secretToken")
                 .build())
         .filters(List.of(WebhookFilterRuleProperty.builder()
                 .jsonPath("jsonPath")
                 // the properties below are optional
                 .matchEquals("matchEquals")
                 .build()))
         .targetAction("targetAction")
         .targetPipeline("targetPipeline")
         .targetPipelineVersion(123)
         // the properties below are optional
         .name("name")
         .registerWithThirdParty(false)
         .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	CfnWebhookProps.Builder	A builder for CfnWebhookProps
static final class	CfnWebhookProps.Jsii$Proxy	An implementation for CfnWebhookProps

Method Summary

Modifier and Type	Method	Description
static CfnWebhookProps.Builder	builder()
String	getAuthentication()	Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
Object	getAuthenticationConfiguration()	Properties that configure the authentication applied to incoming webhook trigger requests.
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.
String	getTargetAction()	The name of the action in a pipeline you want to connect to the webhook.
String	getTargetPipeline()	The name of the pipeline you want to connect to the webhook.
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)
@NotNull
String getAuthentication()

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.

See Also:

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

getAuthenticationConfiguration

@Stability(Stable)
@NotNull
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.

See Also:

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

getFilters

@Stability(Stable)
@NotNull
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.

See Also:

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

getTargetAction

@Stability(Stable)
@NotNull
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)
@NotNull
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)
@NotNull
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

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.

See Also:

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

builder

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

Returns:

a CfnWebhookProps.Builder of CfnWebhookProps