Package software.amazon.awssdk.services.codepipeline.model

Class WebhookAuthConfiguration

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.WebhookAuthConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WebhookAuthConfiguration.Builder,WebhookAuthConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class WebhookAuthConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebhookAuthConfiguration.Builder,WebhookAuthConfiguration>

The authentication applied to incoming webhook trigger requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebhookAuthConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	allowedIPRange()	The property used to configure acceptance of webhooks in an IP address range.
static WebhookAuthConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretToken()	The property used to configure GitHub authentication.
static Class<? extends WebhookAuthConfiguration.Builder>	serializableBuilderClass()
WebhookAuthConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

allowedIPRange

public final String allowedIPRange()

The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

Returns:

The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

secretToken

public final String secretToken()

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

If a secret token was provided, it will be redacted in the response.

Returns:

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

If a secret token was provided, it will be redacted in the response.

toBuilder

public WebhookAuthConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WebhookAuthConfiguration.Builder,WebhookAuthConfiguration>

builder

public static WebhookAuthConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends WebhookAuthConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo