class Amazonite::EventBridge::PutEventsRequestEntry

Overview

Represents an event to be submitted.

Included Modules

Defined in:

eventbridge/put_events_request_entry.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(time : Time | Nil = nil, source : String | Nil = nil, resources : Array(String) | Nil = nil, detail_type : String | Nil = nil, detail : String | Nil = nil, event_bus_name : String | Nil = nil, trace_header : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def detail : String | Nil #

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.


[View source]
def detail=(detail : String | Nil) #

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.


[View source]
def detail_type : String | Nil #

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.


[View source]
def detail_type=(detail_type : String | Nil) #

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.


[View source]
def event_bus_name : String | Nil #

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


[View source]
def event_bus_name=(event_bus_name : String | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def resources : Array(String) | Nil #

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


[View source]
def resources=(resources : Array(String) | Nil) #

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


[View source]
def source : String | Nil #

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.


[View source]
def source=(source : String | Nil) #

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.


[View source]
def time : Time | Nil #

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


[View source]
def time=(time : Time | Nil) #

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


[View source]
def trace_header : String | Nil #

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.


[View source]
def trace_header=(trace_header : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]