class ContextAttribute

Language	Type name
.NET	Amazon.CDK.AWS.Scheduler.ContextAttribute
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsscheduler#ContextAttribute
Java	software.amazon.awscdk.services.scheduler.ContextAttribute
Python	aws_cdk.aws_scheduler.ContextAttribute
TypeScript (source)	aws-cdk-lib » aws_scheduler » ContextAttribute

A set of convenient static methods representing the Scheduler Context Attributes.

These Context Attributes keywords can be used inside a ScheduleTargetInput.

See also: https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html

Properties

Name	Type	Description
name	string
static attemptNumber	string	A counter that identifies the attempt number for the current invocation, for example, 1.
static executionId	string	The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3.
static scheduleArn	string	The ARN of the schedule.
static scheduledTime	string	The time you specified for the schedule to invoke its target, for example, 2022-03-22T18:59:43Z.

---

name

Type: string

---

static attemptNumber

Type: string

A counter that identifies the attempt number for the current invocation, for example, 1.

---

static executionId

Type: string

The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3.

---

static scheduleArn

Type: string

The ARN of the schedule.

---

static scheduledTime

Type: string

The time you specified for the schedule to invoke its target, for example, 2022-03-22T18:59:43Z.

Methods

Name	Description
toString()	Convert the path to the field in the event pattern to JSON.
static fromName(name)	Escape hatch for other Context Attributes that may be added in the future.

---

toString()

public toString(): string

Returns

• string

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

---

static fromName(name)

public static fromName(name: string): string

Parameters

• name string — - name will replace xxx in <aws.scheduler.xxx>.

Returns

• string

Escape hatch for other Context Attributes that may be added in the future.