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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WebhookAuthConfiguration.Builder,WebhookAuthConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.