software.amazon.awscdk.services.datasync

Class CfnTask.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnTask.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTask>

Enclosing class:

CfnTask

@Stability(value=Stable)
public static final class CfnTask.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTask>

A fluent builder for CfnTask.

Method Summary

Modifier and Type	Method and Description
CfnTask	build()
CfnTask.Builder	cloudWatchLogGroupArn(String cloudWatchLogGroupArn) The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
static CfnTask.Builder	create(software.constructs.Construct scope, String id)
CfnTask.Builder	destinationLocationArn(String destinationLocationArn) The Amazon Resource Name (ARN) of an AWS storage resource's location.
CfnTask.Builder	excludes(IResolvable excludes) A list of filter rules that determines which files to exclude from a task.
CfnTask.Builder	excludes(List<? extends Object> excludes) A list of filter rules that determines which files to exclude from a task.
CfnTask.Builder	includes(IResolvable includes) A list of filter rules that determines which files to include when running a task.
CfnTask.Builder	includes(List<? extends Object> includes) A list of filter rules that determines which files to include when running a task.
CfnTask.Builder	name(String name) The name of a task.
CfnTask.Builder	options(CfnTask.OptionsProperty options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution` .
CfnTask.Builder	options(IResolvable options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution` .
CfnTask.Builder	schedule(CfnTask.TaskScheduleProperty schedule) Specifies a schedule used to periodically transfer files from a source to a destination location.
CfnTask.Builder	schedule(IResolvable schedule) Specifies a schedule used to periodically transfer files from a source to a destination location.
CfnTask.Builder	sourceLocationArn(String sourceLocationArn) The Amazon Resource Name (ARN) of the source location for the task.
CfnTask.Builder	tags(List<? extends CfnTag> tags) The key-value pair that represents the tag that you want to add to the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnTask.Builder create(software.constructs.Construct scope,
                                                              String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnTask.FilterRuleProperty.Builder.

destinationLocationArn

@Stability(value=Stable)
public CfnTask.Builder destinationLocationArn(String destinationLocationArn)

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

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of an AWS storage resource's location. This parameter is required.

Returns:

this

sourceLocationArn

@Stability(value=Stable)
public CfnTask.Builder sourceLocationArn(String sourceLocationArn)

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

Parameters:

sourceLocationArn - The Amazon Resource Name (ARN) of the source location for the task. This parameter is required.

Returns:

this

cloudWatchLogGroupArn

@Stability(value=Stable)
public CfnTask.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

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 .

Parameters:

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

Returns:

this

excludes

@Stability(value=Stable)
public CfnTask.Builder excludes(IResolvable excludes)

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

Parameters:

excludes - A list of filter rules that determines which files to exclude from a task. This parameter is required.

Returns:

this

excludes

@Stability(value=Stable)
public CfnTask.Builder excludes(List<? extends Object> excludes)

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

Parameters:

excludes - A list of filter rules that determines which files to exclude from a task. This parameter is required.

Returns:

this

includes

@Stability(value=Stable)
public CfnTask.Builder includes(IResolvable includes)

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

Parameters:

includes - A list of filter rules that determines which files to include when running a task. This parameter is required.

Returns:

this

includes

@Stability(value=Stable)
public CfnTask.Builder includes(List<? extends Object> includes)

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

Parameters:

includes - A list of filter rules that determines which files to include when running a task. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnTask.Builder name(String name)

The name of a task.

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

Parameters:

name - The name of a task. This parameter is required.

Returns:

this

options

@Stability(value=Stable)
public CfnTask.Builder options(CfnTask.OptionsProperty options)

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.

Parameters:

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

Returns:

this

options

@Stability(value=Stable)
public CfnTask.Builder options(IResolvable options)

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.

Parameters:

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

Returns:

this

schedule

@Stability(value=Stable)
public CfnTask.Builder schedule(CfnTask.TaskScheduleProperty schedule)

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 .

Parameters:

schedule - Specifies a schedule used to periodically transfer files from a source to a destination location. This parameter is required.

Returns:

this

schedule

@Stability(value=Stable)
public CfnTask.Builder schedule(IResolvable schedule)

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 .

Parameters:

schedule - Specifies a schedule used to periodically transfer files from a source to a destination location. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnTask.Builder tags(List<? extends CfnTag> tags)

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

The value can be an empty string.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnTask build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTask>