Interface TaskSchedule.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<TaskSchedule.Builder,TaskSchedule>,SdkBuilder<TaskSchedule.Builder,TaskSchedule>,SdkPojo
- Enclosing class:
- TaskSchedule
public static interface TaskSchedule.Builder extends SdkPojo, CopyableBuilder<TaskSchedule.Builder,TaskSchedule>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TaskSchedule.BuilderscheduleExpression(String scheduleExpression)Specifies your task schedule by using a cron or rate expression.TaskSchedule.Builderstatus(String status)Specifies whether to enable or disable your task schedule.TaskSchedule.Builderstatus(ScheduleStatus status)Specifies whether to enable or disable your task schedule.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
scheduleExpression
TaskSchedule.Builder scheduleExpression(String scheduleExpression)
Specifies your task schedule by using a cron or rate expression.
Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:
cron(0 8 * * 3#1)Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:
rate(12 hours)For information about cron and rate expression syntax, see the Amazon EventBridge User Guide .
- Parameters:
scheduleExpression- Specifies your task schedule by using a cron or rate expression.Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:
cron(0 8 * * 3#1)Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:
rate(12 hours)For information about cron and rate expression syntax, see the Amazon EventBridge User Guide .
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
TaskSchedule.Builder status(String status)
Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.
- Parameters:
status- Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScheduleStatus,ScheduleStatus
-
status
TaskSchedule.Builder status(ScheduleStatus status)
Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.
- Parameters:
status- Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScheduleStatus,ScheduleStatus
-
-