Class WebhookEventsSourceConfiguration

java.lang.Object
software.amazon.awssdk.services.eventbridgev2.model.WebhookEventsSourceConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WebhookEventsSourceConfiguration.Builder,WebhookEventsSourceConfiguration>

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

Configuration for receiving events from an external provider, such as a SaaS application, that sends them as HTTPS POST requests to a webhook URL. The provider authenticates with an HTTP scheme instead of AWS credentials.

See Also:
  • Method Details

    • authConfiguration

      public final WebhookAuthConfiguration authConfiguration()

      How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.

      Returns:
      How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.

      Returns:
      Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.
    • roleArn

      public final String roleArn()

      IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.

      Returns:
      IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.
    • hasMetadataHttpHeaders

      public final boolean hasMetadataHttpHeaders()
      For responses, this returns true if the service returned a value for the MetadataHttpHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • metadataHttpHeaders

      public final List<String> metadataHttpHeaders()

      The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadataHttpHeaders() method.

      Returns:
      The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
    • deduplicationConfiguration

      public final WebhookDeduplicationConfiguration deduplicationConfiguration()

      Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.

      Returns:
      Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
    • logConfiguration

      public final LogConfiguration logConfiguration()

      Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.

      Returns:
      Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
    • 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<WebhookEventsSourceConfiguration.Builder,WebhookEventsSourceConfiguration>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends WebhookEventsSourceConfiguration.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.