Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Interface CfnTaskPropsMixin.TaskScheduleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskPropsMixin.TaskScheduleProperty.Jsii$Proxy

Enclosing class:

CfnTaskPropsMixin

@Stability(Stable)
public static interface CfnTaskPropsMixin.TaskScheduleProperty
extends software.amazon.jsii.JsiiSerializable

Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.datasync.*;
 TaskScheduleProperty taskScheduleProperty = TaskScheduleProperty.builder()
         .scheduleExpression("scheduleExpression")
         .status("status")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTaskPropsMixin.TaskScheduleProperty.Builder	A builder for CfnTaskPropsMixin.TaskScheduleProperty
static final class	CfnTaskPropsMixin.TaskScheduleProperty.Jsii$Proxy	An implementation for CfnTaskPropsMixin.TaskScheduleProperty

Method Summary

Modifier and Type	Method	Description
static CfnTaskPropsMixin.TaskScheduleProperty.Builder	builder()
default String	getScheduleExpression()	Specifies your task schedule by using a cron or rate expression.
default String	getStatus()	Specifies whether to enable or disable your task schedule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScheduleExpression

@Stability(Stable)
@Nullable
default String getScheduleExpression()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-scheduleexpression

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-status

builder

@Stability(Stable)
static CfnTaskPropsMixin.TaskScheduleProperty.Builder builder()

Returns:

a CfnTaskPropsMixin.TaskScheduleProperty.Builder of CfnTaskPropsMixin.TaskScheduleProperty