Package software.amazon.awscdk.services.stepfunctions.tasks

Class EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, EventBridgeSchedulerCreateScheduleTaskProps, TaskStateBaseOptions, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

EventBridgeSchedulerCreateScheduleTaskProps

@Stability(Stable)
@Internal
public static final class EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements EventBridgeSchedulerCreateScheduleTaskProps

An implementation for EventBridgeSchedulerCreateScheduleTaskProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.EventBridgeSchedulerCreateScheduleTaskProps

EventBridgeSchedulerCreateScheduleTaskProps.Builder, EventBridgeSchedulerCreateScheduleTaskProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(EventBridgeSchedulerCreateScheduleTaskProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the EventBridgeSchedulerCreateScheduleTaskProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final ActionAfterCompletion	getActionAfterCompletion()	Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final String	getClientToken()	Unique, case-sensitive identifier to ensure the idempotency of the request.
final String	getComment()	A comment describing this state.
final Credentials	getCredentials()	Credentials for an IAM Role that the State Machine assumes for executing the task.
final String	getDescription()	The description for the schedule.
final Boolean	getEnabled()	Specifies whether the schedule is enabled or disabled.
final Instant	getEndDate()	The date, in UTC, before which the schedule can invoke its target.
final Duration	getFlexibleTimeWindow()	The maximum time window during which a schedule can be invoked.
final String	getGroupName()	The name of the schedule group to associate with this schedule.
final Duration	getHeartbeat()	(deprecated) Timeout for the heartbeat.
final Timeout	getHeartbeatTimeout()	Timeout for the heartbeat.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final IntegrationPattern	getIntegrationPattern()	AWS Step Functions integrates with services directly in the Amazon States Language.
final IKey	getKmsKey()	The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final Schedule	getSchedule()	The schedule that defines when the schedule will trigger.
final String	getScheduleName()	Schedule name.
final Instant	getStartDate()	The date, in UTC, after which the schedule can begin invoking its target.
final String	getStateName()	Optional name for this state.
final EventBridgeSchedulerTarget	getTarget()	The schedule's target.
final Timeout	getTaskTimeout()	Timeout for the task.
final Duration	getTimeout()	(deprecated) Timeout for the task.
final String	getTimezone()	The timezone in which the scheduling expression is evaluated.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(EventBridgeSchedulerCreateScheduleTaskProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the EventBridgeSchedulerCreateScheduleTaskProps.Builder.

Method Details

getSchedule

public final Schedule getSchedule()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The schedule that defines when the schedule will trigger.

Specified by:

getSchedule in interface EventBridgeSchedulerCreateScheduleTaskProps

See Also:

• https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html

getScheduleName

public final String getScheduleName()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

Schedule name.

Specified by:

getScheduleName in interface EventBridgeSchedulerCreateScheduleTaskProps

getTarget

public final EventBridgeSchedulerTarget getTarget()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The schedule's target.

Specified by:

getTarget in interface EventBridgeSchedulerCreateScheduleTaskProps

getActionAfterCompletion

public final ActionAfterCompletion getActionAfterCompletion()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Default: ActionAfterCompletion.NONE

Specified by:

getActionAfterCompletion in interface EventBridgeSchedulerCreateScheduleTaskProps

getClientToken

public final String getClientToken()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

Unique, case-sensitive identifier to ensure the idempotency of the request.

Default: - Automatically generated

Specified by:

getClientToken in interface EventBridgeSchedulerCreateScheduleTaskProps

getDescription

public final String getDescription()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The description for the schedule.

Default: - No description

Specified by:

getDescription in interface EventBridgeSchedulerCreateScheduleTaskProps

getEnabled

public final Boolean getEnabled()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

Specifies whether the schedule is enabled or disabled.

Default: true

Specified by:

getEnabled in interface EventBridgeSchedulerCreateScheduleTaskProps

getEndDate

public final Instant getEndDate()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The date, in UTC, before which the schedule can invoke its target.

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

Specified by:

getEndDate in interface EventBridgeSchedulerCreateScheduleTaskProps

getFlexibleTimeWindow

public final Duration getFlexibleTimeWindow()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The maximum time window during which a schedule can be invoked.

Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).

Default: - Flexible time window is not enabled.

Specified by:

getFlexibleTimeWindow in interface EventBridgeSchedulerCreateScheduleTaskProps

getGroupName

public final String getGroupName()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The name of the schedule group to associate with this schedule.

Default: - The default schedule group is used.

Specified by:

getGroupName in interface EventBridgeSchedulerCreateScheduleTaskProps

getKmsKey

public final IKey getKmsKey()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.

Default: - Use automatically generated KMS key

Specified by:

getKmsKey in interface EventBridgeSchedulerCreateScheduleTaskProps

See Also:

• https://docs.aws.amazon.com/scheduler/latest/UserGuide/encryption-rest.html

getStartDate

public final Instant getStartDate()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The date, in UTC, after which the schedule can begin invoking its target.

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

Specified by:

getStartDate in interface EventBridgeSchedulerCreateScheduleTaskProps

getTimezone

public final String getTimezone()

Description copied from interface: EventBridgeSchedulerCreateScheduleTaskProps

The timezone in which the scheduling expression is evaluated.

Default: - UTC

Specified by:

getTimezone in interface EventBridgeSchedulerCreateScheduleTaskProps

getResultPath

public final String getResultPath()

Description copied from interface: TaskStateBaseProps

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

Specified by:

getResultPath in interface TaskStateBaseProps

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: TaskStateBaseProps

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

Specified by:

getResultSelector in interface TaskStateBaseProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getCredentials

public final Credentials getCredentials()

Description copied from interface: TaskStateBaseOptions

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

Specified by:

getCredentials in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

getHeartbeat

public final Duration getHeartbeat()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the heartbeat.

Default: - None

Specified by:

getHeartbeat in interface TaskStateBaseOptions

getHeartbeatTimeout

public final Timeout getHeartbeatTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getHeartbeatTimeout in interface TaskStateBaseOptions

getIntegrationPattern

public final IntegrationPattern getIntegrationPattern()

Description copied from interface: TaskStateBaseOptions

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

Specified by:

getIntegrationPattern in interface TaskStateBaseOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

getTaskTimeout

public final Timeout getTaskTimeout()

Description copied from interface: TaskStateBaseOptions

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Specified by:

getTaskTimeout in interface TaskStateBaseOptions

getTimeout

public final Duration getTimeout()

Description copied from interface: TaskStateBaseOptions

(deprecated) Timeout for the task.

Default: - None

Specified by:

getTimeout in interface TaskStateBaseOptions

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getInputPath

public final String getInputPath()

Description copied from interface: JsonPathCommonOptions

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: JsonPathCommonOptions

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

Specified by:

getOutputPath in interface JsonPathCommonOptions

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object