Interface IEventBridgeSchedulerCreateScheduleTaskJsonPathProps
Properties for creating an AWS EventBridge Scheduler schedule using JSONPath.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEventBridgeSchedulerCreateScheduleTaskJsonPathProps : ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsSyntax (vb)
Public Interface IEventBridgeSchedulerCreateScheduleTaskJsonPathProps
Inherits ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
EventBridgeSchedulerTarget eventBridgeSchedulerTarget;
Key key;
var resultSelector;
Schedule schedule;
TaskRole taskRole;
Timeout timeout;
var eventBridgeSchedulerCreateScheduleTaskJsonPathProps = new EventBridgeSchedulerCreateScheduleTaskJsonPathProps {
Schedule = schedule,
ScheduleName = "scheduleName",
Target = eventBridgeSchedulerTarget,
// the properties below are optional
ActionAfterCompletion = ActionAfterCompletion.NONE,
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
ClientToken = "clientToken",
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
Description = "description",
Enabled = false,
EndDate = new Date(),
FlexibleTimeWindow = Duration.Minutes(30),
GroupName = "groupName",
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
KmsKey = key,
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StartDate = new Date(),
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30),
Timezone = "timezone"
};Synopsis
Properties
| Action |
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target. |
| Client |
Unique, case-sensitive identifier to ensure the idempotency of the request. |
| Description | The description for the schedule. |
| Enabled | Specifies whether the schedule is enabled or disabled. |
| End |
The date, in UTC, before which the schedule can invoke its target. |
| Flexible |
The maximum time window during which a schedule can be invoked. |
| Group |
The name of the schedule group to associate with this schedule. |
| Kms |
The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload. |
| Schedule | The schedule that defines when the schedule will trigger. |
| Schedule |
Schedule name. |
| Start |
The date, in UTC, after which the schedule can begin invoking its target. |
| Target | The schedule's target. |
| Timezone | The timezone in which the scheduling expression is evaluated. |
Properties
ActionAfterCompletion
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
virtual Nullable<ActionAfterCompletion> ActionAfterCompletion { get; }Property Value
System.
Remarks
Default: ActionAfterCompletion.NONE
ClientToken
Unique, case-sensitive identifier to ensure the idempotency of the request.
virtual string ClientToken { get; }Property Value
System.
Remarks
Default: - Automatically generated
Description
The description for the schedule.
virtual string Description { get; }Property Value
System.
Remarks
Default: - No description
Enabled
Specifies whether the schedule is enabled or disabled.
virtual Nullable<bool> Enabled { get; }Property Value
System.
Remarks
Default: true
EndDate
The date, in UTC, before which the schedule can invoke its target.
virtual Nullable<DateTime> EndDate { get; }Property Value
System.
Remarks
Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
Default: - No end date
FlexibleTimeWindow
The maximum time window during which a schedule can be invoked.
virtual Duration FlexibleTimeWindow { get; }Property Value
Remarks
Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).
Default: - Flexible time window is not enabled.
GroupName
The name of the schedule group to associate with this schedule.
virtual string GroupName { get; }Property Value
System.
Remarks
Default: - The default schedule group is used.
KmsKey
The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.
virtual IKey KmsKey { get; }Property Value
Remarks
Default: - Use automatically generated KMS key
See: https://docs.aws.amazon.com/scheduler/latest/UserGuide/encryption-rest.html
Schedule
The schedule that defines when the schedule will trigger.
Schedule Schedule { get; }Property Value
Remarks
ScheduleName
Schedule name.
string ScheduleName { get; }Property Value
System.
StartDate
The date, in UTC, after which the schedule can begin invoking its target.
virtual Nullable<DateTime> StartDate { get; }Property Value
System.
Remarks
Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
Default: - No start date
Target
The schedule's target.
EventBridgeSchedulerTarget Target { get; }Property Value
Timezone
The timezone in which the scheduling expression is evaluated.
virtual string Timezone { get; }Property Value
System.
Remarks
Default: - UTC