software.amazon.awscdk.services.datasync

Class CfnTask.Builder

java.lang.Object

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

Enclosing class:

CfnTask

public static final class CfnTask.Builder
extends java.lang.Object

A fluent builder for CfnTask.

Method Summary

Modifier and Type	Method and Description
CfnTask	build()
CfnTask.Builder	cloudWatchLogGroupArn(java.lang.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(Construct scope, java.lang.String id)
CfnTask.Builder	destinationLocationArn(java.lang.String destinationLocationArn) The Amazon Resource Name (ARN) of an AWS storage resource's location.
CfnTask.Builder	excludes(IResolvable excludes) Specifies a list of filter rules that exclude specific data during your transfer.
CfnTask.Builder	excludes(java.util.List<? extends java.lang.Object> excludes) Specifies a list of filter rules that exclude specific data during your transfer.
CfnTask.Builder	includes(IResolvable includes) Specifies a list of filter rules that include specific data during your transfer.
CfnTask.Builder	includes(java.util.List<? extends java.lang.Object> includes) Specifies a list of filter rules that include specific data during your transfer.
CfnTask.Builder	name(java.lang.String name) The name of a task.
CfnTask.Builder	options(CfnTask.OptionsProperty options) Specifies the configuration options for a task.
CfnTask.Builder	options(IResolvable options) Specifies the configuration options for a task.
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(java.lang.String sourceLocationArn) The Amazon Resource Name (ARN) of the source location for the task.
CfnTask.Builder	tags(java.util.List<? extends CfnTag> tags) Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnTask.Builder create(Construct scope,
                                     java.lang.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

public CfnTask.Builder destinationLocationArn(java.lang.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

public CfnTask.Builder sourceLocationArn(java.lang.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

public CfnTask.Builder cloudWatchLogGroupArn(java.lang.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

public CfnTask.Builder excludes(IResolvable excludes)

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

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

Parameters:

excludes - Specifies a list of filter rules that exclude specific data during your transfer. This parameter is required.

Returns:

this

excludes

public CfnTask.Builder excludes(java.util.List<? extends java.lang.Object> excludes)

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

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

Parameters:

excludes - Specifies a list of filter rules that exclude specific data during your transfer. This parameter is required.

Returns:

this

includes

public CfnTask.Builder includes(IResolvable includes)

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

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

Parameters:

includes - Specifies a list of filter rules that include specific data during your transfer. This parameter is required.

Returns:

this

includes

public CfnTask.Builder includes(java.util.List<? extends java.lang.Object> includes)

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

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

Parameters:

includes - Specifies a list of filter rules that include specific data during your transfer. This parameter is required.

Returns:

this

name

public CfnTask.Builder name(java.lang.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

public CfnTask.Builder options(IResolvable options)

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 .

Parameters:

options - Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity. This parameter is required.

Returns:

this

options

public CfnTask.Builder options(CfnTask.OptionsProperty options)

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 .

Parameters:

options - Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity. This parameter is required.

Returns:

this

schedule

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

schedule

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

tags

public CfnTask.Builder tags(java.util.List<? extends CfnTag> tags)

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.

Parameters:

tags - Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task. This parameter is required.

Returns:

this

build

public CfnTask build()