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

Interface CfnTaskMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.887Z")
@Stability(Stable)
public interface CfnTaskMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnTaskPropsMixin.

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.*;
 CfnTaskMixinProps cfnTaskMixinProps = CfnTaskMixinProps.builder()
         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
         .destinationLocationArn("destinationLocationArn")
         .excludes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .includes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .manifestConfig(ManifestConfigProperty.builder()
                 .action("action")
                 .format("format")
                 .source(SourceProperty.builder()
                         .s3(ManifestConfigSourceS3Property.builder()
                                 .bucketAccessRoleArn("bucketAccessRoleArn")
                                 .manifestObjectPath("manifestObjectPath")
                                 .manifestObjectVersionId("manifestObjectVersionId")
                                 .s3BucketArn("s3BucketArn")
                                 .build())
                         .build())
                 .build())
         .name("name")
         .options(OptionsProperty.builder()
                 .atime("atime")
                 .bytesPerSecond(123)
                 .gid("gid")
                 .logLevel("logLevel")
                 .mtime("mtime")
                 .objectTags("objectTags")
                 .overwriteMode("overwriteMode")
                 .posixPermissions("posixPermissions")
                 .preserveDeletedFiles("preserveDeletedFiles")
                 .preserveDevices("preserveDevices")
                 .securityDescriptorCopyFlags("securityDescriptorCopyFlags")
                 .taskQueueing("taskQueueing")
                 .transferMode("transferMode")
                 .uid("uid")
                 .verifyMode("verifyMode")
                 .build())
         .schedule(TaskScheduleProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .status("status")
                 .build())
         .sourceLocationArn("sourceLocationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskMode("taskMode")
         .taskReportConfig(TaskReportConfigProperty.builder()
                 .destination(DestinationProperty.builder()
                         .s3(S3Property.builder()
                                 .bucketAccessRoleArn("bucketAccessRoleArn")
                                 .s3BucketArn("s3BucketArn")
                                 .subdirectory("subdirectory")
                                 .build())
                         .build())
                 .objectVersionIds("objectVersionIds")
                 .outputType("outputType")
                 .overrides(OverridesProperty.builder()
                         .deleted(DeletedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .skipped(SkippedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .transferred(TransferredProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .verified(VerifiedProperty.builder()
                                 .reportLevel("reportLevel")
                                 .build())
                         .build())
                 .reportLevel("reportLevel")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTaskMixinProps.Builder	builder()
default Object	getCloudWatchLogGroupArn()	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
default Object	getDestinationLocationArn()	The Amazon Resource Name (ARN) of an AWS storage resource's location.
default Object	getExcludes()	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
default Object	getIncludes()	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
default Object	getManifestConfig()	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
default String	getName()	Specifies the name of your task.
default Object	getOptions()	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
default Object	getSchedule()	Specifies a schedule for when you want your task to run.
default Object	getSourceLocationArn()	Specifies the ARN of your transfer's source location.
default List<CfnTag>	getTags()	Specifies the tags that you want to apply to your task.
default String	getTaskMode()	The task mode that you're using.
default Object	getTaskReportConfig()	The configuration of your task report, which provides detailed information about your DataSync transfer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudWatchLogGroupArn

@Stability(Stable)
@Nullable
default Object getCloudWatchLogGroupArn()

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync .

For more information, see Monitoring data transfers with CloudWatch Logs .

Returns union: either String or ILogGroupRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn

getDestinationLocationArn

@Stability(Stable)
@Nullable
default Object getDestinationLocationArn()

The Amazon Resource Name (ARN) of an AWS storage resource's location.

Returns union: either String or ILocationEFSRef or ILocationS3Ref

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn

getExcludes

@Stability(Stable)
@Nullable
default Object getExcludes()

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskPropsMixin.FilterRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes

getIncludes

@Stability(Stable)
@Nullable
default Object getIncludes()

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTaskPropsMixin.FilterRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes

getManifestConfig

@Stability(Stable)
@Nullable
default Object getManifestConfig()

The configuration of the manifest that lists the files or objects that you want DataSync to transfer.

For more information, see Specifying what DataSync transfers by using a manifest .

Returns union: either IResolvable or CfnTaskPropsMixin.ManifestConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig

getName

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

Specifies the name of your task.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name

getOptions

@Stability(Stable)
@Nullable
default Object getOptions()

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Returns union: either IResolvable or CfnTaskPropsMixin.OptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

getSchedule

@Stability(Stable)
@Nullable
default Object getSchedule()

Specifies a schedule for when you want your task to run.

For more information, see Scheduling your task .

Returns union: either IResolvable or CfnTaskPropsMixin.TaskScheduleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

getSourceLocationArn

@Stability(Stable)
@Nullable
default Object getSourceLocationArn()

Specifies the ARN of your transfer's source location.

Returns union: either String or ILocationNFSRef or ILocationS3Ref

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Specifies the tags that you want to apply to your task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-tags

getTaskMode

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

The task mode that you're using.

For more information, see Choosing a task mode for your data transfer .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskmode

getTaskReportConfig

@Stability(Stable)
@Nullable
default Object getTaskReportConfig()

The configuration of your task report, which provides detailed information about your DataSync transfer.

For more information, see Monitoring your DataSync transfers with task reports .

Returns union: either IResolvable or CfnTaskPropsMixin.TaskReportConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig

builder

@Stability(Stable)
static CfnTaskMixinProps.Builder builder()

Returns:

a CfnTaskMixinProps.Builder of CfnTaskMixinProps