class ContextAttribute
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Scheduler.Alpha.ContextAttribute |
Go | github.com/aws/aws-cdk-go/awscdkscheduleralpha/v2#ContextAttribute |
Java | software.amazon.awscdk.services.scheduler.alpha.ContextAttribute |
Python | aws_cdk.aws_scheduler_alpha.ContextAttribute |
TypeScript (source) | @aws-cdk/aws-scheduler-alpha ยป ContextAttribute |
Represents a field in the event pattern.
See also: https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html
Properties
Name | Type | Description |
---|---|---|
name | string | |
static attempt | string | A counter that identifies the attempt number for the current invocation, for example, 1. |
static execution | string | The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3. |
static schedule | string | The ARN of the schedule. |
static scheduled | 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 |
---|---|
to | Convert the path to the field in the event pattern to JSON. |
static from | Escape hatch for other ContextAttribute that might be resolved in future. |
String()
topublic toString(): string
Returns
string
Convert the path to the field in the event pattern to JSON.
Name(name)
static frompublic static fromName(name: string): string
Parameters
- name
string
โ - name will replace xxx in <aws.scheduler.xxx>.
Returns
string
Escape hatch for other ContextAttribute that might be resolved in future.