software.amazon.awscdk.services.codepipeline

Class CfnWebhookProps.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.CfnWebhookProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebhookProps>

Enclosing interface:

CfnWebhookProps

@Stability(value=Stable)
public static final class CfnWebhookProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebhookProps>

A builder for CfnWebhookProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnWebhookProps.Builder	authentication(String authentication) Sets the value of CfnWebhookProps.getAuthentication()
CfnWebhookProps.Builder	authenticationConfiguration(CfnWebhook.WebhookAuthConfigurationProperty authenticationConfiguration) Sets the value of CfnWebhookProps.getAuthenticationConfiguration()
CfnWebhookProps.Builder	authenticationConfiguration(IResolvable authenticationConfiguration) Sets the value of CfnWebhookProps.getAuthenticationConfiguration()
CfnWebhookProps	build() Builds the configured instance.
CfnWebhookProps.Builder	filters(IResolvable filters) Sets the value of CfnWebhookProps.getFilters()
CfnWebhookProps.Builder	filters(List<? extends Object> filters) Sets the value of CfnWebhookProps.getFilters()
CfnWebhookProps.Builder	name(String name) Sets the value of CfnWebhookProps.getName()
CfnWebhookProps.Builder	registerWithThirdParty(Boolean registerWithThirdParty) Sets the value of CfnWebhookProps.getRegisterWithThirdParty()
CfnWebhookProps.Builder	registerWithThirdParty(IResolvable registerWithThirdParty) Sets the value of CfnWebhookProps.getRegisterWithThirdParty()
CfnWebhookProps.Builder	targetAction(String targetAction) Sets the value of CfnWebhookProps.getTargetAction()
CfnWebhookProps.Builder	targetPipeline(String targetPipeline) Sets the value of CfnWebhookProps.getTargetPipeline()
CfnWebhookProps.Builder	targetPipelineVersion(Number targetPipelineVersion) Sets the value of CfnWebhookProps.getTargetPipelineVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authentication

@Stability(value=Stable)
public CfnWebhookProps.Builder authentication(String authentication)

Sets the value of CfnWebhookProps.getAuthentication()

Parameters:

authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. This parameter is required.

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

Returns:

this

authenticationConfiguration

@Stability(value=Stable)
public CfnWebhookProps.Builder authenticationConfiguration(IResolvable authenticationConfiguration)

Sets the value of CfnWebhookProps.getAuthenticationConfiguration()

Parameters:

authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. This parameter is required. 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.

Returns:

this

authenticationConfiguration

@Stability(value=Stable)
public CfnWebhookProps.Builder authenticationConfiguration(CfnWebhook.WebhookAuthConfigurationProperty authenticationConfiguration)

Sets the value of CfnWebhookProps.getAuthenticationConfiguration()

Parameters:

authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. This parameter is required. 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.

Returns:

this

filters

@Stability(value=Stable)
public CfnWebhookProps.Builder filters(IResolvable filters)

Sets the value of CfnWebhookProps.getFilters()

Parameters:

filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. This parameter is required. All defined rules must pass for the request to be accepted and the pipeline started.

Returns:

this

filters

@Stability(value=Stable)
public CfnWebhookProps.Builder filters(List<? extends Object> filters)

Sets the value of CfnWebhookProps.getFilters()

Parameters:

filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. This parameter is required. All defined rules must pass for the request to be accepted and the pipeline started.

Returns:

this

targetAction

@Stability(value=Stable)
public CfnWebhookProps.Builder targetAction(String targetAction)

Sets the value of CfnWebhookProps.getTargetAction()

Parameters:

targetAction - The name of the action in a pipeline you want to connect to the webhook. This parameter is required. The action must be from the source (first) stage of the pipeline.

Returns:

this

targetPipeline

@Stability(value=Stable)
public CfnWebhookProps.Builder targetPipeline(String targetPipeline)

Sets the value of CfnWebhookProps.getTargetPipeline()

Parameters:

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

Returns:

this

targetPipelineVersion

@Stability(value=Stable)
public CfnWebhookProps.Builder targetPipelineVersion(Number targetPipelineVersion)

Sets the value of CfnWebhookProps.getTargetPipelineVersion()

Parameters:

targetPipelineVersion - The version number of the pipeline to be connected to the trigger request. This parameter is required. Required: Yes

Type: Integer

Update requires: No interruption

Returns:

this

name

@Stability(value=Stable)
public CfnWebhookProps.Builder name(String name)

Sets the value of CfnWebhookProps.getName()

Parameters:

name - The name of the webhook.

Returns:

this

registerWithThirdParty

@Stability(value=Stable)
public CfnWebhookProps.Builder registerWithThirdParty(Boolean registerWithThirdParty)

Sets the value of CfnWebhookProps.getRegisterWithThirdParty()

Parameters:

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

Returns:

this

registerWithThirdParty

@Stability(value=Stable)
public CfnWebhookProps.Builder registerWithThirdParty(IResolvable registerWithThirdParty)

Sets the value of CfnWebhookProps.getRegisterWithThirdParty()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnWebhookProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWebhookProps>

Returns:

a new instance of CfnWebhookProps

Throws:

NullPointerException - if any required attribute was not provided