software.amazon.awscdk.services.datasync

Interface CfnTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.901Z")
 @Stability(value=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()))
         .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")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTaskProps.Builder	builder()
default String	getCloudWatchLogGroupArn() The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
String	getDestinationLocationArn() The Amazon Resource Name (ARN) of an AWS storage resource's location.
default Object	getExcludes() A list of filter rules that determines which files to exclude from a task.
default Object	getIncludes() A list of filter rules that determines which files to include when running a task.
default String	getName() The name of a task.
default Object	getOptions() The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution` .
default Object	getSchedule() Specifies a schedule used to periodically transfer files from a source to a destination location.
String	getSourceLocationArn() The Amazon Resource Name (ARN) of the source location for the task.
default List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestinationLocationArn

@Stability(value=Stable)
 @NotNull
String getDestinationLocationArn()

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

getSourceLocationArn

@Stability(value=Stable)
 @NotNull
String getSourceLocationArn()

The Amazon Resource Name (ARN) of the source location for the task.

getCloudWatchLogGroupArn

@Stability(value=Stable)
 @Nullable
default String getCloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .

getExcludes

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

A list of filter rules that determines which files to exclude from a task.

The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2" .

getIncludes

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

A list of filter rules that determines which files to include when running a task.

The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2" .

getName

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

The name of a task.

This value is a text reference that is used to identify the task in the console.

getOptions

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

The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution` .

You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

getSchedule

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

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

getTags

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

The key-value pair that represents the tag that you want to add to the resource.

The value can be an empty string.

builder

@Stability(value=Stable)
static CfnTaskProps.Builder builder()

Returns:

a CfnTaskProps.Builder of CfnTaskProps