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

Class CfnTaskPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnTaskPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.901Z")
@Stability(Stable)
public class CfnTaskPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::DataSync::Task resource specifies a task.

A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTaskPropsMixin cfnTaskPropsMixin = CfnTaskPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTaskPropsMixin.Builder	A fluent builder for CfnTaskPropsMixin.
static interface	CfnTaskPropsMixin.DeletedProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
static interface	CfnTaskPropsMixin.DestinationProperty	Specifies where DataSync uploads your task report.
static interface	CfnTaskPropsMixin.FilterRuleProperty	Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
static interface	CfnTaskPropsMixin.ManifestConfigProperty	Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.
static interface	CfnTaskPropsMixin.ManifestConfigSourceS3Property	Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
static interface	CfnTaskPropsMixin.OptionsProperty	Represents the options that are available to control the behavior of a StartTaskExecution operation.
static interface	CfnTaskPropsMixin.OverridesProperty	Customizes the reporting level for aspects of your task report.
static interface	CfnTaskPropsMixin.S3Property	Example:
static interface	CfnTaskPropsMixin.SkippedProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
static interface	CfnTaskPropsMixin.SourceProperty	Specifies the manifest that you want DataSync to use and where it's hosted.
static interface	CfnTaskPropsMixin.TaskReportConfigProperty	Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.
static interface	CfnTaskPropsMixin.TaskScheduleProperty	Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).
static interface	CfnTaskPropsMixin.TransferredProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
static interface	CfnTaskPropsMixin.VerifiedProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTaskPropsMixin(CfnTaskMixinProps props)	Create a mixin to apply properties to AWS::DataSync::Task.
	CfnTaskPropsMixin(CfnTaskMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::DataSync::Task.
protected	CfnTaskPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTaskPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTaskMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTaskPropsMixin

protected CfnTaskPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnTaskPropsMixin

protected CfnTaskPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTaskPropsMixin

@Stability(Stable)
public CfnTaskPropsMixin(@NotNull
 CfnTaskMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::DataSync::Task.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTaskPropsMixin

@Stability(Stable)
public CfnTaskPropsMixin(@NotNull
 CfnTaskMixinProps props)

Create a mixin to apply properties to AWS::DataSync::Task.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTaskMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()