Class: Aws::EventBridge::Types::PutEventsRequestEntry
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::PutEventsRequestEntry
- Defined in:
- gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb
Overview
Represents an event to be submitted.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#detail ⇒ String
A valid JSON object.
-
#detail_type ⇒ String
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
-
#event_bus_name ⇒ String
The name or ARN of the event bus to receive the event.
-
#resources ⇒ Array<String>
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
-
#source ⇒ String
The source of the event.
-
#time ⇒ Time
The time stamp of the event, per [RFC3339][1].
-
#trace_header ⇒ String
An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
Instance Attribute Details
#detail ⇒ String
A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
Detail
, DetailType
, and Source
are required for EventBridge to
successfully send an event to an event bus. If you include event
entries in a request that do not include each of those properties,
EventBridge fails that entry. If you submit a request in which
none of the entries have each of these properties, EventBridge
fails the entire request.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#detail_type ⇒ String
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
Detail
, DetailType
, and Source
are required for EventBridge to
successfully send an event to an event bus. If you include event
entries in a request that do not include each of those properties,
EventBridge fails that entry. If you submit a request in which
none of the entries have each of these properties, EventBridge
fails the entire request.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#event_bus_name ⇒ String
The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.
EndpointId
. Specifying the event
bus ARN is preferred.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#resources ⇒ Array<String>
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#source ⇒ String
The source of the event.
Detail
, DetailType
, and Source
are required for EventBridge to
successfully send an event to an event bus. If you include event
entries in a request that do not include each of those properties,
EventBridge fails that entry. If you submit a request in which
none of the entries have each of these properties, EventBridge
fails the entire request.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#time ⇒ Time
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |
#trace_header ⇒ String
An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3536 class PutEventsRequestEntry < Struct.new( :time, :source, :resources, :detail_type, :detail, :event_bus_name, :trace_header) SENSITIVE = [] include Aws::Structure end |