All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:37.889Z") @Stability(Stable) public interface CfnTaskProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTask.

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.*;
 CfnTaskProps cfnTaskProps = CfnTaskProps.builder()
         .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnTaskProps.Builder

A builder for CfnTaskProps

static final class

CfnTaskProps.Jsii$Proxy

An implementation for CfnTaskProps
Method Summary

Modifier and Type

Method

Description

static CfnTaskProps.Builder

builder()

default 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.

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.

String

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
- getDestinationLocationArn
  
  @Stability(Stable) @NotNull String getDestinationLocationArn()
  
  The Amazon Resource Name (ARN) of an AWS storage resource's location.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn
- getSourceLocationArn
  
  @Stability(Stable) @NotNull String getSourceLocationArn()
  
  Specifies the ARN of your transfer's source location.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn
- getCloudWatchLogGroupArn
  
  @Stability(Stable) @Nullable default String 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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn
- 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 CfnTask.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 CfnTask.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 CfnTask.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 CfnTask.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 CfnTask.TaskScheduleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule
- 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 CfnTask.TaskReportConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig
- builder
  
  @Stability(Stable) static CfnTaskProps.Builder builder()
  
  Returns:
  
  a CfnTaskProps.Builder of CfnTaskProps

Interface CfnTaskProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDestinationLocationArn

getSourceLocationArn

getCloudWatchLogGroupArn

getExcludes

getIncludes

getManifestConfig

getName

getOptions

getSchedule

getTags

getTaskMode

getTaskReportConfig

builder