Class: Aws::EventBridgeV2::Types::WebhookEventsSourceConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_configuration ⇒ Types::WebhookAuthConfiguration

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



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deduplication_configuration ⇒ Types::WebhookDeduplicationConfiguration

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



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

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:

  • (String)


3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ Types::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.



3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_http_headers ⇒ Array<String>

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.

Returns:

  • (Array<String>)


3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String)


3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3630

class WebhookEventsSourceConfiguration < Struct.new(
  :auth_configuration,
  :kms_key_identifier,
  :role_arn,
  :metadata_http_headers,
  :deduplication_configuration,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end