software.amazon.awssdk.services.codepipeline.model

Interface WebhookDefinition.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>, SdkBuilder<WebhookDefinition.Builder,WebhookDefinition>, SdkPojo

Enclosing class:

WebhookDefinition

public static interface WebhookDefinition.Builder
extends SdkPojo, CopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>

Method Summary

Modifier and Type	Method and Description
WebhookDefinition.Builder	authentication(String authentication) Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
WebhookDefinition.Builder	authentication(WebhookAuthenticationType authentication) Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
default WebhookDefinition.Builder	authenticationConfiguration(Consumer<WebhookAuthConfiguration.Builder> authenticationConfiguration) Properties that configure the authentication applied to incoming webhook trigger requests.
WebhookDefinition.Builder	authenticationConfiguration(WebhookAuthConfiguration authenticationConfiguration) Properties that configure the authentication applied to incoming webhook trigger requests.
WebhookDefinition.Builder	filters(Collection<WebhookFilterRule> filters) A list of rules applied to the body/payload sent in the POST request to a webhook URL.
WebhookDefinition.Builder	filters(Consumer<WebhookFilterRule.Builder>... filters) A list of rules applied to the body/payload sent in the POST request to a webhook URL.
WebhookDefinition.Builder	filters(WebhookFilterRule... filters) A list of rules applied to the body/payload sent in the POST request to a webhook URL.
WebhookDefinition.Builder	name(String name) The name of the webhook.
WebhookDefinition.Builder	targetAction(String targetAction) The name of the action in a pipeline you want to connect to the webhook.
WebhookDefinition.Builder	targetPipeline(String targetPipeline) The name of the pipeline you want to connect to the webhook.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

WebhookDefinition.Builder name(String name)

The name of the webhook.

Parameters:

name - The name of the webhook.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetPipeline

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetAction

WebhookDefinition.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. The action must be from the source (first) stage of the pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

WebhookDefinition.Builder filters(Collection<WebhookFilterRule> 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. All defined rules must pass for the request to be accepted and the pipeline started.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

WebhookDefinition.Builder filters(WebhookFilterRule... 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. All defined rules must pass for the request to be accepted and the pipeline started.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

WebhookDefinition.Builder filters(Consumer<WebhookFilterRule.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

authentication

WebhookDefinition.Builder authentication(String authentication)

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

• GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/

• IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Parameters:

authentication - Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

• GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/

• IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebhookAuthenticationType, WebhookAuthenticationType

authentication

WebhookDefinition.Builder authentication(WebhookAuthenticationType authentication)

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

• GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/

• IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Parameters:

authentication - Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

• GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/

• IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

• UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebhookAuthenticationType, WebhookAuthenticationType

authenticationConfiguration

WebhookDefinition.Builder authenticationConfiguration(WebhookAuthConfiguration 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. 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:

Returns a reference to this object so that method calls can be chained together.

authenticationConfiguration

default WebhookDefinition.Builder authenticationConfiguration(Consumer<WebhookAuthConfiguration.Builder> 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.

This is a convenience that creates an instance of the WebhookAuthConfiguration.Builder avoiding the need to create one manually via WebhookAuthConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(WebhookAuthConfiguration).

Parameters:

authenticationConfiguration - a consumer that will call methods on WebhookAuthConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authenticationConfiguration(WebhookAuthConfiguration)