Package software.amazon.awscdk.services.datasync

Class CfnTask

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datasync.CfnTask

All Implemented Interfaces:

IInspectable, ITaskRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.038Z")
@Stability(Stable)
public class CfnTask
extends CfnResource
implements IInspectable, ITaskRef, ITaggable

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.services.datasync.*;
 CfnTask cfnTask = CfnTask.Builder.create(this, "MyCfnTask")
         .destinationLocationArn("destinationLocationArn")
         .sourceLocationArn("sourceLocationArn")
         // the properties below are optional
         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
         .excludes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .includes(List.of(FilterRuleProperty.builder()
                 .filterType("filterType")
                 .value("value")
                 .build()))
         .manifestConfig(ManifestConfigProperty.builder()
                 .source(SourceProperty.builder()
                         .s3(ManifestConfigSourceS3Property.builder()
                                 .bucketAccessRoleArn("bucketAccessRoleArn")
                                 .manifestObjectPath("manifestObjectPath")
                                 .manifestObjectVersionId("manifestObjectVersionId")
                                 .s3BucketArn("s3BucketArn")
                                 .build())
                         .build())
                 // the properties below are optional
                 .action("action")
                 .format("format")
                 .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())
         .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())
                 .outputType("outputType")
                 // the properties below are optional
                 .objectVersionIds("objectVersionIds")
                 .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	Class	Description
static final class	CfnTask.Builder	A fluent builder for CfnTask.
static interface	CfnTask.DeletedProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
static interface	CfnTask.DestinationProperty	Specifies where DataSync uploads your task report.
static interface	CfnTask.FilterRuleProperty	Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
static interface	CfnTask.ManifestConfigProperty	Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.
static interface	CfnTask.ManifestConfigSourceS3Property	Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
static interface	CfnTask.OptionsProperty	Represents the options that are available to control the behavior of a StartTaskExecution operation.
static interface	CfnTask.OverridesProperty	Customizes the reporting level for aspects of your task report.
static interface	CfnTask.S3Property	Example:
static interface	CfnTask.SkippedProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
static interface	CfnTask.SourceProperty	Specifies the manifest that you want DataSync to use and where it's hosted.
static interface	CfnTask.TaskReportConfigProperty	Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.
static interface	CfnTask.TaskScheduleProperty	Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).
static interface	CfnTask.TransferredProperty	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
static interface	CfnTask.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.datasync.ITaskRef

ITaskRef.Jsii$Default, ITaskRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTask(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTask(software.constructs.Construct scope, String id, CfnTaskProps props)	Create a new AWS::DataSync::Task.

Method Summary

Modifier and Type	Method	Description
static String	arnForTask(ITaskRef resource)
List<String>	getAttrDestinationNetworkInterfaceArns()	The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
List<String>	getAttrSourceNetworkInterfaceArns()	The ARNs of the source ENIs that were created for your subnet.
String	getAttrStatus()	The status of the task that was described.
String	getAttrTaskArn()	The ARN of the task.
protected Map<String,Object>	getCfnProperties()
String	getCloudWatchLogGroupArn()	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
String	getDestinationLocationArn()	The Amazon Resource Name (ARN) of an AWS storage resource's location.
Object	getExcludes()	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
Object	getIncludes()	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
Object	getManifestConfig()	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
String	getName()	Specifies the name of your task.
Object	getOptions()	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
Object	getSchedule()	Specifies a schedule for when you want your task to run.
String	getSourceLocationArn()	Specifies the ARN of your transfer's source location.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Specifies the tags that you want to apply to your task.
String	getTaskMode()	The task mode that you're using.
TaskReference	getTaskRef()	A reference to a Task resource.
Object	getTaskReportConfig()	The configuration of your task report, which provides detailed information about your DataSync transfer.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnTask(Object x)	Checks whether the given object is a CfnTask.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCloudWatchLogGroupArn(String value)	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
void	setDestinationLocationArn(String value)	The Amazon Resource Name (ARN) of an AWS storage resource's location.
void	setExcludes(List<Object> value)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
void	setExcludes(IResolvable value)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
void	setIncludes(List<Object> value)	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
void	setIncludes(IResolvable value)	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
void	setManifestConfig(IResolvable value)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
void	setManifestConfig(CfnTask.ManifestConfigProperty value)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
void	setName(String value)	Specifies the name of your task.
void	setOptions(IResolvable value)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
void	setOptions(CfnTask.OptionsProperty value)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
void	setSchedule(IResolvable value)	Specifies a schedule for when you want your task to run.
void	setSchedule(CfnTask.TaskScheduleProperty value)	Specifies a schedule for when you want your task to run.
void	setSourceLocationArn(String value)	Specifies the ARN of your transfer's source location.
void	setTagsRaw(List<CfnTag> value)	Specifies the tags that you want to apply to your task.
void	setTaskMode(String value)	The task mode that you're using.
void	setTaskReportConfig(IResolvable value)	The configuration of your task report, which provides detailed information about your DataSync transfer.
void	setTaskReportConfig(CfnTask.TaskReportConfigProperty value)	The configuration of your task report, which provides detailed information about your DataSync transfer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTask

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

CfnTask

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

CfnTask

@Stability(Stable)
public CfnTask(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTaskProps props)

Create a new AWS::DataSync::Task.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForTask

@Stability(Stable)
@NotNull
public static String arnForTask(@NotNull
 ITaskRef resource)

Parameters:

resource - This parameter is required.

isCfnTask

@Stability(Stable)
@NotNull
public static Boolean isCfnTask(@NotNull
 Object x)

Checks whether the given object is a CfnTask.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDestinationNetworkInterfaceArns

@Stability(Stable)
@NotNull
public List<String> getAttrDestinationNetworkInterfaceArns()

The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.

getAttrSourceNetworkInterfaceArns

@Stability(Stable)
@NotNull
public List<String> getAttrSourceNetworkInterfaceArns()

The ARNs of the source ENIs that were created for your subnet.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of the task that was described.

getAttrTaskArn

@Stability(Stable)
@NotNull
public String getAttrTaskArn()

The ARN of the task.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getTaskRef

@Stability(Stable)
@NotNull
public TaskReference getTaskRef()

A reference to a Task resource.

Specified by:

getTaskRef in interface ITaskRef

getDestinationLocationArn

@Stability(Stable)
@NotNull
public String getDestinationLocationArn()

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

setDestinationLocationArn

@Stability(Stable)
public void setDestinationLocationArn(@NotNull
 String value)

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

getSourceLocationArn

@Stability(Stable)
@NotNull
public String getSourceLocationArn()

Specifies the ARN of your transfer's source location.

setSourceLocationArn

@Stability(Stable)
public void setSourceLocationArn(@NotNull
 String value)

Specifies the ARN of your transfer's source location.

getCloudWatchLogGroupArn

@Stability(Stable)
@Nullable
public String getCloudWatchLogGroupArn()

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

setCloudWatchLogGroupArn

@Stability(Stable)
public void setCloudWatchLogGroupArn(@Nullable
 String value)

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

getExcludes

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

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

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

setExcludes

@Stability(Stable)
public void setExcludes(@Nullable
 IResolvable value)

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

setExcludes

@Stability(Stable)
public void setExcludes(@Nullable
 List<Object> value)

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

getIncludes

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

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

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

setIncludes

@Stability(Stable)
public void setIncludes(@Nullable
 IResolvable value)

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

setIncludes

@Stability(Stable)
public void setIncludes(@Nullable
 List<Object> value)

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

getManifestConfig

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

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

Returns union: either IResolvable or CfnTask.ManifestConfigProperty

setManifestConfig

@Stability(Stable)
public void setManifestConfig(@Nullable
 IResolvable value)

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

setManifestConfig

@Stability(Stable)
public void setManifestConfig(@Nullable
 CfnTask.ManifestConfigProperty value)

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

getName

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

Specifies the name of your task.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

Specifies the name of your task.

getOptions

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

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

Returns union: either IResolvable or CfnTask.OptionsProperty

setOptions

@Stability(Stable)
public void setOptions(@Nullable
 IResolvable value)

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

setOptions

@Stability(Stable)
public void setOptions(@Nullable
 CfnTask.OptionsProperty value)

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

getSchedule

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

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

Returns union: either IResolvable or CfnTask.TaskScheduleProperty

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 IResolvable value)

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

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 CfnTask.TaskScheduleProperty value)

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

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

getTaskMode

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

The task mode that you're using.

setTaskMode

@Stability(Stable)
public void setTaskMode(@Nullable
 String value)

The task mode that you're using.

getTaskReportConfig

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

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

Returns union: either IResolvable or CfnTask.TaskReportConfigProperty

setTaskReportConfig

@Stability(Stable)
public void setTaskReportConfig(@Nullable
 IResolvable value)

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

setTaskReportConfig

@Stability(Stable)
public void setTaskReportConfig(@Nullable
 CfnTask.TaskReportConfigProperty value)

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