Aws::EventBridge::Model::PutEventsRequestEntry Class Reference

#include <PutEventsRequestEntry.h>

Public Member Functions

AWS_EVENTBRIDGE_API PutEventsRequestEntry ()=default

 

AWS_EVENTBRIDGE_API PutEventsRequestEntry (Aws::Utils::Json::JsonView jsonValue)

 

AWS_EVENTBRIDGE_API PutEventsRequestEntry & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_EVENTBRIDGE_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::Utils::DateTime & GetTime () const

 

bool TimeHasBeenSet () const

 

template<typename TimeT = Aws::Utils::DateTime>

void SetTime (TimeT &&value)

 

template<typename TimeT = Aws::Utils::DateTime>

PutEventsRequestEntry & WithTime (TimeT &&value)

 

const Aws::String & GetSource () const

 

bool SourceHasBeenSet () const

 

template<typename SourceT = Aws::String>

void SetSource (SourceT &&value)

 

template<typename SourceT = Aws::String>

PutEventsRequestEntry & WithSource (SourceT &&value)

 

const Aws::Vector< Aws::String > & GetResources () const

 

bool ResourcesHasBeenSet () const

 

template<typename ResourcesT = Aws::Vector<Aws::String>>

void SetResources (ResourcesT &&value)

 

template<typename ResourcesT = Aws::Vector<Aws::String>>

PutEventsRequestEntry & WithResources (ResourcesT &&value)

 

template<typename ResourcesT = Aws::String>

PutEventsRequestEntry & AddResources (ResourcesT &&value)

 

const Aws::String & GetDetailType () const

 

bool DetailTypeHasBeenSet () const

 

template<typename DetailTypeT = Aws::String>

void SetDetailType (DetailTypeT &&value)

 

template<typename DetailTypeT = Aws::String>

PutEventsRequestEntry & WithDetailType (DetailTypeT &&value)

 

const Aws::String & GetDetail () const

 

bool DetailHasBeenSet () const

 

template<typename DetailT = Aws::String>

void SetDetail (DetailT &&value)

 

template<typename DetailT = Aws::String>

PutEventsRequestEntry & WithDetail (DetailT &&value)

 

const Aws::String & GetEventBusName () const

 

bool EventBusNameHasBeenSet () const

 

template<typename EventBusNameT = Aws::String>

void SetEventBusName (EventBusNameT &&value)

 

template<typename EventBusNameT = Aws::String>

PutEventsRequestEntry & WithEventBusName (EventBusNameT &&value)

 

const Aws::String & GetTraceHeader () const

 

bool TraceHeaderHasBeenSet () const

 

template<typename TraceHeaderT = Aws::String>

void SetTraceHeader (TraceHeaderT &&value)

 

template<typename TraceHeaderT = Aws::String>

PutEventsRequestEntry & WithTraceHeader (TraceHeaderT &&value)

 

Detailed Description

Represents an event to be submitted.

See Also:

AWS API Reference

Definition at line 29 of file PutEventsRequestEntry.h.

Constructor & Destructor Documentation

PutEventsRequestEntry() [1/2]

AWS_EVENTBRIDGE_API Aws::EventBridge::Model::PutEventsRequestEntry::PutEventsRequestEntry ( )

default

PutEventsRequestEntry() [2/2]

AWS_EVENTBRIDGE_API Aws::EventBridge::Model::PutEventsRequestEntry::PutEventsRequestEntry ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

AddResources()

template<typename ResourcesT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::AddResources ( ResourcesT &&  value)

inline

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

Definition at line 100 of file PutEventsRequestEntry.h.

DetailHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::DetailHasBeenSet ( ) const

inline

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.

Definition at line 142 of file PutEventsRequestEntry.h.

DetailTypeHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::DetailTypeHasBeenSet ( ) const

inline

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.

Definition at line 118 of file PutEventsRequestEntry.h.

EventBusNameHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::EventBusNameHasBeenSet ( ) const

inline

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.

Definition at line 167 of file PutEventsRequestEntry.h.

GetDetail()

const Aws::String & Aws::EventBridge::Model::PutEventsRequestEntry::GetDetail ( ) const

inline

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.

Definition at line 141 of file PutEventsRequestEntry.h.

GetDetailType()

const Aws::String & Aws::EventBridge::Model::PutEventsRequestEntry::GetDetailType ( ) const

inline

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.

Definition at line 117 of file PutEventsRequestEntry.h.

GetEventBusName()

const Aws::String & Aws::EventBridge::Model::PutEventsRequestEntry::GetEventBusName ( ) const

inline

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.

Definition at line 166 of file PutEventsRequestEntry.h.

GetResources()

const Aws::Vector< Aws::String > & Aws::EventBridge::Model::PutEventsRequestEntry::GetResources ( ) const

inline

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

Definition at line 87 of file PutEventsRequestEntry.h.

GetSource()

const Aws::String & Aws::EventBridge::Model::PutEventsRequestEntry::GetSource ( ) const

inline

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.

Definition at line 67 of file PutEventsRequestEntry.h.

GetTime()

const Aws::Utils::DateTime & Aws::EventBridge::Model::PutEventsRequestEntry::GetTime ( ) const

inline

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

Definition at line 44 of file PutEventsRequestEntry.h.

GetTraceHeader()

const Aws::String & Aws::EventBridge::Model::PutEventsRequestEntry::GetTraceHeader ( ) const

inline

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.

Definition at line 188 of file PutEventsRequestEntry.h.

Jsonize()

AWS_EVENTBRIDGE_API Aws::Utils::Json::JsonValue Aws::EventBridge::Model::PutEventsRequestEntry::Jsonize ( ) const

operator=()

AWS_EVENTBRIDGE_API PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::operator= ( Aws::Utils::Json::JsonView  jsonValue)

ResourcesHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::ResourcesHasBeenSet ( ) const

inline

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

Definition at line 88 of file PutEventsRequestEntry.h.

SetDetail()

template<typename DetailT = Aws::String>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetDetail ( DetailT &&  value)

inline

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.

Definition at line 144 of file PutEventsRequestEntry.h.

SetDetailType()

template<typename DetailTypeT = Aws::String>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetDetailType ( DetailTypeT &&  value)

inline

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.

Definition at line 120 of file PutEventsRequestEntry.h.

SetEventBusName()

template<typename EventBusNameT = Aws::String>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetEventBusName ( EventBusNameT &&  value)

inline

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.

Definition at line 169 of file PutEventsRequestEntry.h.

SetResources()

template<typename ResourcesT = Aws::Vector<Aws::String>>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetResources ( ResourcesT &&  value)

inline

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

Definition at line 90 of file PutEventsRequestEntry.h.

SetSource()

template<typename SourceT = Aws::String>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetSource ( SourceT &&  value)

inline

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.

Definition at line 70 of file PutEventsRequestEntry.h.

SetTime()

template<typename TimeT = Aws::Utils::DateTime>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetTime ( TimeT &&  value)

inline

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

Definition at line 47 of file PutEventsRequestEntry.h.

SetTraceHeader()

template<typename TraceHeaderT = Aws::String>

void Aws::EventBridge::Model::PutEventsRequestEntry::SetTraceHeader ( TraceHeaderT &&  value)

inline

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.

Definition at line 191 of file PutEventsRequestEntry.h.

SourceHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::SourceHasBeenSet ( ) const

inline

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.

Definition at line 68 of file PutEventsRequestEntry.h.

TimeHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::TimeHasBeenSet ( ) const

inline

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

Definition at line 45 of file PutEventsRequestEntry.h.

TraceHeaderHasBeenSet()

bool Aws::EventBridge::Model::PutEventsRequestEntry::TraceHeaderHasBeenSet ( ) const

inline

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.

Definition at line 189 of file PutEventsRequestEntry.h.

WithDetail()

template<typename DetailT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithDetail ( DetailT &&  value)

inline

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.

Definition at line 149 of file PutEventsRequestEntry.h.

WithDetailType()

template<typename DetailTypeT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithDetailType ( DetailTypeT &&  value)

inline

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.

Definition at line 125 of file PutEventsRequestEntry.h.

WithEventBusName()

template<typename EventBusNameT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithEventBusName ( EventBusNameT &&  value)

inline

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.

Definition at line 174 of file PutEventsRequestEntry.h.

WithResources()

template<typename ResourcesT = Aws::Vector<Aws::String>>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithResources ( ResourcesT &&  value)

inline

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

Definition at line 95 of file PutEventsRequestEntry.h.

WithSource()

template<typename SourceT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithSource ( SourceT &&  value)

inline

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.

Definition at line 75 of file PutEventsRequestEntry.h.

WithTime()

template<typename TimeT = Aws::Utils::DateTime>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithTime ( TimeT &&  value)

inline

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

Definition at line 52 of file PutEventsRequestEntry.h.

WithTraceHeader()

template<typename TraceHeaderT = Aws::String>

PutEventsRequestEntry & Aws::EventBridge::Model::PutEventsRequestEntry::WithTraceHeader ( TraceHeaderT &&  value)

inline

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.

Definition at line 196 of file PutEventsRequestEntry.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-eventbridge/include/aws/eventbridge/model/PutEventsRequestEntry.h