software.amazon.awscdk.services.codepipeline

Class CfnWebhook

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codepipeline.CfnWebhook

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.463Z")
 @Stability(value=Stable)
public class CfnWebhook
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodePipeline::Webhook`.

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 Configure Your GitHub Pipelines to Use Webhooks for 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.services.codepipeline.*;
 CfnWebhook cfnWebhook = CfnWebhook.Builder.create(this, "MyCfnWebhook")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWebhook.Builder A fluent builder for CfnWebhook.
static interface	CfnWebhook.WebhookAuthConfigurationProperty The authentication applied to incoming webhook trigger requests.
static interface	CfnWebhook.WebhookFilterRuleProperty The event criteria that specify when a webhook notification is sent to your URL.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWebhook(software.constructs.Construct scope, String id, CfnWebhookProps props) Create a new `AWS::CodePipeline::Webhook`.
protected	CfnWebhook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWebhook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrUrl() The webhook URL generated by AWS CodePipeline , such as `https://eu-central-1.webhooks.aws/trigger123456` .
String	getAuthentication() Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
Object	getAuthenticationConfiguration() Properties that configure the authentication applied to incoming webhook trigger requests.
protected Map<String,Object>	getCfnProperties()
Object	getFilters() A list of rules applied to the body/payload sent in the POST request to a webhook URL.
String	getName() The name of the webhook.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthentication(String value) Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
void	setAuthenticationConfiguration(CfnWebhook.WebhookAuthConfigurationProperty value) Properties that configure the authentication applied to incoming webhook trigger requests.
void	setAuthenticationConfiguration(IResolvable value) Properties that configure the authentication applied to incoming webhook trigger requests.
void	setFilters(IResolvable value) A list of rules applied to the body/payload sent in the POST request to a webhook URL.
void	setFilters(List<Object> value) A list of rules applied to the body/payload sent in the POST request to a webhook URL.
void	setName(String value) The name of the webhook.
void	setRegisterWithThirdParty(Boolean value) Configures a connection between the webhook that was created and the external tool with events to be detected.
void	setRegisterWithThirdParty(IResolvable value) Configures a connection between the webhook that was created and the external tool with events to be detected.
void	setTargetAction(String value) The name of the action in a pipeline you want to connect to the webhook.
void	setTargetPipeline(String value) The name of the pipeline you want to connect to the webhook.
void	setTargetPipelineVersion(Number value) The version number of the pipeline to be connected to the trigger request.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWebhook

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

CfnWebhook

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

CfnWebhook

@Stability(value=Stable)
public CfnWebhook(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnWebhookProps props)

Create a new `AWS::CodePipeline::Webhook`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrUrl

@Stability(value=Stable)
 @NotNull
public String getAttrUrl()

The webhook URL generated by AWS CodePipeline , such as `https://eu-central-1.webhooks.aws/trigger123456` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthentication

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

setAuthentication

@Stability(value=Stable)
public void setAuthentication(@NotNull
                                                       String value)

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.

getAuthenticationConfiguration

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

setAuthenticationConfiguration

@Stability(value=Stable)
public void setAuthenticationConfiguration(@NotNull
                                                                    CfnWebhook.WebhookAuthConfigurationProperty value)

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.

setAuthenticationConfiguration

@Stability(value=Stable)
public void setAuthenticationConfiguration(@NotNull
                                                                    IResolvable value)

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.

getFilters

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

setFilters

@Stability(value=Stable)
public void setFilters(@NotNull
                                                IResolvable value)

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.

setFilters

@Stability(value=Stable)
public void setFilters(@NotNull
                                                List<Object> value)

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.

getTargetAction

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

setTargetAction

@Stability(value=Stable)
public void setTargetAction(@NotNull
                                                     String value)

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.

getTargetPipeline

@Stability(value=Stable)
 @NotNull
public String getTargetPipeline()

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

setTargetPipeline

@Stability(value=Stable)
public void setTargetPipeline(@NotNull
                                                       String value)

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

getTargetPipelineVersion

@Stability(value=Stable)
 @NotNull
public Number getTargetPipelineVersion()

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

Required: Yes

Type: Integer

Update requires: No interruption

setTargetPipelineVersion

@Stability(value=Stable)
public void setTargetPipelineVersion(@NotNull
                                                              Number value)

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

Required: Yes

Type: Integer

Update requires: No interruption

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the webhook.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the webhook.

getRegisterWithThirdParty

@Stability(value=Stable)
 @Nullable
public Object getRegisterWithThirdParty()

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

setRegisterWithThirdParty

@Stability(value=Stable)
public void setRegisterWithThirdParty(@Nullable
                                                               Boolean value)

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

setRegisterWithThirdParty

@Stability(value=Stable)
public void setRegisterWithThirdParty(@Nullable
                                                               IResolvable value)

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