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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 subobjects.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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.

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)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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

#time ⇒ Time

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)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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.

Returns:

• (String)

# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3345

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