Class EventBridgeSchedulerCreateScheduleTask

Create a new AWS EventBridge Scheduler schedule.

Inheritance
object
State
TaskStateBase
EventBridgeSchedulerCreateScheduleTask
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EventBridgeSchedulerCreateScheduleTask : TaskStateBase, IChainable, INextable
Syntax (vb)
Public Class EventBridgeSchedulerCreateScheduleTask Inherits TaskStateBase Implements IChainable, INextable
Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Scheduler;
             using Amazon.CDK.AWS.KMS;

             Key key;
             CfnScheduleGroup scheduleGroup;
             Queue targetQueue;
             Queue deadLetterQueue;


             var schedulerRole = new Role(this, "SchedulerRole", new RoleProps {
                 AssumedBy = new ServicePrincipal("scheduler.amazonaws.com")
             });
             // To send the message to the queue
             // This policy changes depending on the type of target.
             schedulerRole.AddToPrincipalPolicy(new PolicyStatement(new PolicyStatementProps {
                 Actions = new [] { "sqs:SendMessage" },
                 Resources = new [] { targetQueue.QueueArn }
             }));

             var createScheduleTask1 = new EventBridgeSchedulerCreateScheduleTask(this, "createSchedule", new EventBridgeSchedulerCreateScheduleTaskProps {
                 ScheduleName = "TestSchedule",
                 ActionAfterCompletion = ActionAfterCompletion.NONE,
                 ClientToken = "testToken",
                 Description = "TestDescription",
                 StartDate = new Date(),
                 EndDate = new Date(new Date().GetTime() + 1000 * 60 * 60),
                 FlexibleTimeWindow = Duration.Minutes(5),
                 GroupName = scheduleGroup.Ref,
                 KmsKey = key,
                 Schedule = Schedule.Rate(Duration.Minutes(5)),
                 Timezone = "UTC",
                 Enabled = true,
                 Target = new EventBridgeSchedulerTarget(new EventBridgeSchedulerTargetProps {
                     Arn = targetQueue.QueueArn,
                     Role = schedulerRole,
                     RetryPolicy = new RetryPolicy {
                         MaximumRetryAttempts = 2,
                         MaximumEventAge = Duration.Minutes(5)
                     },
                     DeadLetterQueue = deadLetterQueue
                 })
             });

Synopsis

Constructors

EventBridgeSchedulerCreateScheduleTask(Construct, string, IEventBridgeSchedulerCreateScheduleTaskProps)

Create a new AWS EventBridge Scheduler schedule.

Properties

TaskMetrics

Create a new AWS EventBridge Scheduler schedule.
TaskPolicies

Create a new AWS EventBridge Scheduler schedule.

Methods

JsonPath(Construct, string, IEventBridgeSchedulerCreateScheduleTaskJsonPathProps)

Create an AWS EventBridge Scheduler schedule using JSONPath.
Jsonata(Construct, string, IEventBridgeSchedulerCreateScheduleTaskJsonataProps)

Create an AWS EventBridge Scheduler schedule using JSONata.

Constructors

EventBridgeSchedulerCreateScheduleTask(Construct, string, IEventBridgeSchedulerCreateScheduleTaskProps)

Create a new AWS EventBridge Scheduler schedule.

public EventBridgeSchedulerCreateScheduleTask(Construct scope, string id, IEventBridgeSchedulerCreateScheduleTaskProps props)
Parameters
scope Construct
id string

Descriptive identifier for this chainable.

props IEventBridgeSchedulerCreateScheduleTaskProps
Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

Properties

TaskMetrics

Create a new AWS EventBridge Scheduler schedule.

protected override ITaskMetricsConfig? TaskMetrics { get; }
Property Value

ITaskMetricsConfig

Overrides
Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

TaskPolicies

Create a new AWS EventBridge Scheduler schedule.

protected override PolicyStatement[]? TaskPolicies { get; }
Property Value

PolicyStatement[]

Overrides
Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

Methods

JsonPath(Construct, string, IEventBridgeSchedulerCreateScheduleTaskJsonPathProps)

Create an AWS EventBridge Scheduler schedule using JSONPath.

public static EventBridgeSchedulerCreateScheduleTask JsonPath(Construct scope, string id, IEventBridgeSchedulerCreateScheduleTaskJsonPathProps props)
Parameters
scope Construct
id string
props IEventBridgeSchedulerCreateScheduleTaskJsonPathProps
Returns

EventBridgeSchedulerCreateScheduleTask

Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

Jsonata(Construct, string, IEventBridgeSchedulerCreateScheduleTaskJsonataProps)

Create an AWS EventBridge Scheduler schedule using JSONata.

public static EventBridgeSchedulerCreateScheduleTask Jsonata(Construct scope, string id, IEventBridgeSchedulerCreateScheduleTaskJsonataProps props)
Parameters
scope Construct
id string
props IEventBridgeSchedulerCreateScheduleTaskJsonataProps
Returns

EventBridgeSchedulerCreateScheduleTask

Remarks

See: https://docs.aws.amazon.com/scheduler/latest/APIReference/API_CreateSchedule.html

ExampleMetadata: infused

Implements