EventBridgeSchedulerCreateScheduleTaskJsonPathProps Struct
Properties for creating an AWS EventBridge Scheduler schedule using JSONPath.
| Source | aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
declare const assign: any;
declare const eventBridgeSchedulerTarget: stepfunctions_tasks.EventBridgeSchedulerTarget;
declare const key: kms.Key;
declare const resultSelector: any;
declare const schedule: stepfunctions_tasks.Schedule;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const eventBridgeSchedulerCreateScheduleTaskJsonPathProps: stepfunctions_tasks.EventBridgeSchedulerCreateScheduleTaskJsonPathProps = {
schedule: schedule,
scheduleName: 'scheduleName',
target: eventBridgeSchedulerTarget,
// the properties below are optional
actionAfterCompletion: stepfunctions_tasks.ActionAfterCompletion.NONE,
assign: {
assignKey: assign,
},
clientToken: 'clientToken',
comment: 'comment',
credentials: {
role: taskRole,
},
description: 'description',
enabled: false,
endDate: new Date(),
flexibleTimeWindow: cdk.Duration.minutes(30),
groupName: 'groupName',
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
kmsKey: key,
outputPath: 'outputPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
startDate: new Date(),
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
timezone: 'timezone',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_kms as kms
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# assign: Any
# event_bridge_scheduler_target: stepfunctions_tasks.EventBridgeSchedulerTarget
# key: kms.Key
# result_selector: Any
# schedule: stepfunctions_tasks.Schedule
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
event_bridge_scheduler_create_schedule_task_json_path_props = stepfunctions_tasks.EventBridgeSchedulerCreateScheduleTaskJsonPathProps(
schedule=schedule,
schedule_name="scheduleName",
target=event_bridge_scheduler_target,
# the properties below are optional
action_after_completion=stepfunctions_tasks.ActionAfterCompletion.NONE,
assign={
"assign_key": assign
},
client_token="clientToken",
comment="comment",
credentials=stepfunctions.Credentials(
role=task_role
),
description="description",
enabled=False,
end_date=Date(),
flexible_time_window=cdk.Duration.minutes(30),
group_name="groupName",
heartbeat=cdk.Duration.minutes(30),
heartbeat_timeout=timeout,
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
kms_key=key,
output_path="outputPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
start_date=Date(),
state_name="stateName",
task_timeout=timeout,
timeout=cdk.Duration.minutes(30),
timezone="timezone"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.kms.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Object assign;
EventBridgeSchedulerTarget eventBridgeSchedulerTarget;
Key key;
Object resultSelector;
Schedule schedule;
TaskRole taskRole;
Timeout timeout;
EventBridgeSchedulerCreateScheduleTaskJsonPathProps eventBridgeSchedulerCreateScheduleTaskJsonPathProps = EventBridgeSchedulerCreateScheduleTaskJsonPathProps.builder()
.schedule(schedule)
.scheduleName("scheduleName")
.target(eventBridgeSchedulerTarget)
// the properties below are optional
.actionAfterCompletion(ActionAfterCompletion.NONE)
.assign(Map.of(
"assignKey", assign))
.clientToken("clientToken")
.comment("comment")
.credentials(Credentials.builder()
.role(taskRole)
.build())
.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(Map.of(
"resultSelectorKey", resultSelector))
.startDate(new Date())
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.timezone("timezone")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// 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"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var assign interface{}
var eventBridgeSchedulerTarget EventBridgeSchedulerTarget
var key Key
var resultSelector interface{}
var schedule Schedule
var taskRole TaskRole
var timeout Timeout
eventBridgeSchedulerCreateScheduleTaskJsonPathProps := &EventBridgeSchedulerCreateScheduleTaskJsonPathProps{
Schedule: schedule,
ScheduleName: jsii.String("scheduleName"),
Target: eventBridgeSchedulerTarget,
// the properties below are optional
ActionAfterCompletion: awscdk.Aws_stepfunctions_tasks.ActionAfterCompletion_NONE,
Assign: map[string]interface{}{
"assignKey": assign,
},
ClientToken: jsii.String("clientToken"),
Comment: jsii.String("comment"),
Credentials: &Credentials{
Role: taskRole,
},
Description: jsii.String("description"),
Enabled: jsii.Boolean(false),
EndDate: NewDate(),
FlexibleTimeWindow: cdk.Duration_Minutes(jsii.Number(30)),
GroupName: jsii.String("groupName"),
Heartbeat: cdk.Duration_*Minutes(jsii.Number(30)),
HeartbeatTimeout: timeout,
InputPath: jsii.String("inputPath"),
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
KmsKey: key,
OutputPath: jsii.String("outputPath"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
StartDate: NewDate(),
StateName: jsii.String("stateName"),
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
Timezone: jsii.String("timezone"),
}
Properties
actionAfterCompletionoptionalActionAfterCompletionaction_after_completionoptionalActionAfterCompletionactionAfterCompletionoptionalActionAfterCompletionActionAfterCompletionoptionalActionAfterCompletionActionAfterCompletionoptionalActionAfterCompletion = ActionAfterCompletion.NONE #assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*string #Default: Automatically generated
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #Default: No description
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool = true #endDateoptionaldateend_dateoptionaldatetimeendDateoptionalInstantEndDateoptionalDateTimeEndDateoptional*time.Time #Default: No end date
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.
flexibleTimeWindowoptionalDurationflexible_time_windowoptionalDurationflexibleTimeWindowoptionalDurationFlexibleTimeWindowoptionalDurationFlexibleTimeWindowoptionalDuration #Default: Flexible time window is not enabled.
Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).
groupNameoptionalstringgroup_nameoptionalstrgroupNameoptionalStringGroupNameoptionalstringGroupNameoptional*string #Default: The default schedule group is used.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: Use automatically generated KMS key
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{} = None #You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
scheduleNamestringschedule_namestrscheduleNameStringScheduleNamestringScheduleName*string required #startDateoptionaldatestart_dateoptionaldatetimestartDateoptionalInstantStartDateoptionalDateTimeStartDateoptional*time.Time #Default: No start date
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.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #Default: The construct ID will be used as state name
targetEventBridgeSchedulerTargettargetEventBridgeSchedulerTargettargetEventBridgeSchedulerTargetTargetEventBridgeSchedulerTargetTargetEventBridgeSchedulerTarget required #taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = None deprecated #timezoneoptionalstringtimezoneoptionalstrtimezoneoptionalStringTimezoneoptionalstringTimezoneoptional*string = UTC #