Package software.amazon.awscdk.services.scheduler

Class ContextAttribute

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.scheduler.ContextAttribute

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:20.337Z")
@Stability(Stable)
public class ContextAttribute
extends software.amazon.jsii.JsiiObject

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContextAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ContextAttribute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static String	fromName(String name)	Escape hatch for other Context Attributes that may be added in the future.
static String	getAttemptNumber()	A counter that identifies the attempt number for the current invocation, for example, 1.
static String	getExecutionId()	The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3.
String	getName()
static String	getScheduleArn()	The ARN of the schedule.
static String	getScheduledTime()	The time you specified for the schedule to invoke its target, for example, 2022-03-22T18:59:43Z.
String	toString()	Convert the path to the field in the event pattern to JSON.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ContextAttribute

protected ContextAttribute(software.amazon.jsii.JsiiObjectRef objRef)

ContextAttribute

protected ContextAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

fromName

@Stability(Stable)
@NotNull
public static String fromName(@NotNull
 String name)

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

Parameters:

name -

• name will replace xxx in <aws.scheduler.xxx>.

This parameter is required.

toString

@Stability(Stable)
@NotNull
public String toString()

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

Overrides:

toString in class Object

getAttemptNumber

@Stability(Stable)
@NotNull
public static String getAttemptNumber()

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

getExecutionId

@Stability(Stable)
@NotNull
public static String getExecutionId()

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

getScheduleArn

@Stability(Stable)
@NotNull
public static String getScheduleArn()

The ARN of the schedule.

getScheduledTime

@Stability(Stable)
@NotNull
public static String getScheduledTime()

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

getName

@Stability(Stable)
@NotNull
public String getName()