Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.233Z")
@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()))
         .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	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()	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()	Specifies a list of filter rules that exclude specific data during your transfer.
default Object	getIncludes()	Specifies a list of filter rules that include specific data during your transfer.
default String	getName()	The name of a task.
default Object	getOptions()	Specifies the configuration options for a task.
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()	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

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.

getSourceLocationArn

@Stability(Stable)
@NotNull
String getSourceLocationArn()

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

getCloudWatchLogGroupArn

@Stability(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(Stable)
@Nullable
default Object getExcludes()

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

getIncludes

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

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

getName

@Stability(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(Stable)
@Nullable
default Object getOptions()

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution ). For more information, see StartTaskExecution .

getSchedule

@Stability(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(Stable)
@Nullable
default List<CfnTag> getTags()

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

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

builder

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

Returns:

a CfnTaskProps.Builder of CfnTaskProps