software.amazon.awscdk.services.codepipeline

Class CfnWebhook

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codepipeline.CfnWebhook

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.873Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnWebhook(Construct scope,
                  java.lang.String id,
                  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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrUrl

public java.lang.String getAttrUrl()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthentication

public java.lang.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

public void setAuthentication(java.lang.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

public java.lang.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

public void setAuthenticationConfiguration(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.

setAuthenticationConfiguration

public void setAuthenticationConfiguration(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.

getFilters

public java.lang.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

public void setFilters(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

public void setFilters(java.util.List<java.lang.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

public java.lang.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

public void setTargetAction(java.lang.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

public java.lang.String getTargetPipeline()

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

setTargetPipeline

public void setTargetPipeline(java.lang.String value)

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

getTargetPipelineVersion

public java.lang.Number getTargetPipelineVersion()

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

Required: Yes

Type: Integer

Update requires: No interruption

setTargetPipelineVersion

public void setTargetPipelineVersion(java.lang.Number value)

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

Required: Yes

Type: Integer

Update requires: No interruption

getName

public java.lang.String getName()

The name of the webhook.

setName

public void setName(java.lang.String value)

The name of the webhook.

getRegisterWithThirdParty

public java.lang.Object getRegisterWithThirdParty()

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

setRegisterWithThirdParty

public void setRegisterWithThirdParty(java.lang.Boolean value)

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

setRegisterWithThirdParty

public void setRegisterWithThirdParty(IResolvable value)

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