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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::PutEventsRequestEntry

Includes:

Structure

Defined in:

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].

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

<note markdown=“1”> ‘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.

</note>

Returns:

• (String)

# File '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.

<note markdown=“1”> ‘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.

</note>

Returns:

• (String)

# File '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.

<note markdown=“1”> If you’re using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the ‘EndpointId`. Specifying the event bus ARN is preferred.

</note>

Returns:

• (String)

# File '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.

Returns:

• (Array<String>)

# File '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.

<note markdown=“1”> ‘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.

</note>

Returns:

• (String)

# File '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

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

[1]: www.rfc-editor.org/rfc/rfc3339.txt [2]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html

Returns:

• (Time)

# File '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.

[1]: docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader

Returns:

• (String)

# File '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