Class: Aws::EventBridgeV2::Types::WebhookStaticTokenAuthConfiguration

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

Overview

The provider sends the secret as the value of an HTTP header.

Constant Summary collapse

SENSITIVE =
[:secret_value]

Instance Attribute Summary collapse

Instance Attribute Details

#secret_value ⇒ String

The token the provider sends in the header. If you omit it, EventBridge generates one. EventBridge stores the token only in AWS Secrets Manager and never returns it, including from DescribeEventSource. EventBridge compares it against the entire header value, so a provider that sends Authorization: Bearer <token> needs SecretValue to include the "Bearer " prefix.

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3778

class WebhookStaticTokenAuthConfiguration < Struct.new(
  :token_http_header,
  :secret_value)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#token_http_header ⇒ String

The name of the header that carries the secret, for example X-Webhook-Secret. Reserved names are rejected: the names EventBridge's edge writes, such as Host and the X-Forwarded-* family, and the hop-by-hop and framing names an HTTP intermediary may rewrite, such as Connection and Content-Length. Authorization is allowed.

Returns:

  • (String)


3778
3779
3780
3781
3782
3783
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3778

class WebhookStaticTokenAuthConfiguration < Struct.new(
  :token_http_header,
  :secret_value)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end