Class: Aws::EventBridge::Types::PutEventsRequestEntry

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

Overview

Note:

When making an API call, you may pass PutEventsRequestEntry data as a hash:

{
  time: Time.now,
  source: "String",
  resources: ["EventResource"],
  detail_type: "String",
  detail: "String",
  event_bus_name: "NonPartnerEventBusNameOrArn",
  trace_header: "TraceHeader",
}

Represents an event to be submitted.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#detailString

A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects.

Returns:

  • (String)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#detail_typeString

Free-form string used to decide what fields to expect in the event detail.

Returns:

  • (String)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#event_bus_nameString

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.

If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either the primary or secondary Region here and the corresponding event bus in the other Region will be determined based on the endpoint referenced by the EndpointId.

Returns:

  • (String)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesArray<String>

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

Returns:

  • (Array<String>)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#sourceString

The source of the event.

Returns:

  • (String)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#timeTime

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

Returns:

  • (Time)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end

#trace_headerString

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.

Returns:

  • (String)


4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4165

class PutEventsRequestEntry < Struct.new(
  :time,
  :source,
  :resources,
  :detail_type,
  :detail,
  :event_bus_name,
  :trace_header)
  SENSITIVE = []
  include Aws::Structure
end