class EventField

Language	Type name
.NET	Amazon.CDK.AWS.Events.EventField
Java	software.amazon.awscdk.services.events.EventField
Python	aws_cdk.aws_events.EventField
TypeScript (source)	@aws-cdk/aws-events » EventField

Implements IResolvable

Represents a field in the event pattern.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
displayHint	string	Human readable display hint about the event pattern.
path	string	the path to a field in the event pattern.
static account	string	Extract the account from the event.
static detailType	string	Extract the detail type from the event.
static eventId	string	Extract the event ID from the event.
static region	string	Extract the region from the event.
static source	string	Extract the source from the event.
static time	string	Extract the time from the event.

---

creationStack

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.

---

displayHint

Type: string

Human readable display hint about the event pattern.

---

path

Type: string

the path to a field in the event pattern.

---

static account

Type: string

Extract the account from the event.

---

static detailType

Type: string

Extract the detail type from the event.

---

static eventId

Type: string

Extract the event ID from the event.

---

static region

Type: string

Extract the region from the event.

---

static source

Type: string

Extract the source from the event.

---

static time

Type: string

Extract the time from the event.

Methods

Name	Description
resolve(_ctx)	Produce the Token's value at resolution time.
toJSON()	Convert the path to the field in the event pattern to JSON.
toString()	Return a string representation of this resolvable object.
static fromPath(path)	Extract a custom JSON path from the event.

---

resolve(_ctx)

public resolve(_ctx: IResolveContext): any

Parameters

• _ctx IResolveContext

Returns

• any

Produce the Token's value at resolution time.

---

toJSON()

public toJSON(): string

Returns

• string

Convert the path to the field in the event pattern to JSON.

---

toString()

public toString(): string

Returns

• string

Return a string representation of this resolvable object.

Returns a reversible string representation.

---

static fromPath(path)

public static fromPath(path: string): string

Parameters

• path string

Returns

• string

Extract a custom JSON path from the event.