Package 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(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	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(List<? extends Object> excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
CfnTask.Builder	excludes(IResolvable excludes)	Specifies a list of filter rules that exclude specific data during your transfer.
CfnTask.Builder	includes(List<? extends Object> includes)	Specifies a list of filter rules that include 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	manifestConfig(IResolvable manifestConfig)	The configuration of the manifest that lists the files or objects to transfer.
CfnTask.Builder	manifestConfig(CfnTask.ManifestConfigProperty manifestConfig)	The configuration of the manifest that lists the files or objects to transfer.
CfnTask.Builder	name(String name)	The name of a task.
CfnTask.Builder	options(IResolvable options)	Specifies the configuration options for a task.
CfnTask.Builder	options(CfnTask.OptionsProperty options)	Specifies the configuration options for a task.
CfnTask.Builder	schedule(IResolvable schedule)	Specifies a schedule used to periodically transfer files from a source to a destination location.
CfnTask.Builder	schedule(CfnTask.TaskScheduleProperty 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)	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
CfnTask.Builder	taskReportConfig(IResolvable taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
CfnTask.Builder	taskReportConfig(CfnTask.TaskReportConfigProperty taskReportConfig)	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTask.Builder.

destinationLocationArn

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn

sourceLocationArn

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn

cloudWatchLogGroupArn

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn

excludes

@Stability(Stable)
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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes

excludes

@Stability(Stable)
public CfnTask.Builder excludes(List<? extends 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes

includes

@Stability(Stable)
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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes

includes

@Stability(Stable)
public CfnTask.Builder includes(List<? extends 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes

manifestConfig

@Stability(Stable)
public CfnTask.Builder manifestConfig(IResolvable manifestConfig)

The configuration of the manifest that lists the files or objects to transfer.

For more information, see Specifying what DataSync transfers by using a manifest .

Parameters:

manifestConfig - The configuration of the manifest that lists the files or objects to transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig

manifestConfig

@Stability(Stable)
public CfnTask.Builder manifestConfig(CfnTask.ManifestConfigProperty manifestConfig)

The configuration of the manifest that lists the files or objects to transfer.

For more information, see Specifying what DataSync transfers by using a manifest .

Parameters:

manifestConfig - The configuration of the manifest that lists the files or objects to transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig

name

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name

options

@Stability(Stable)
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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

options

@Stability(Stable)
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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

schedule

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

schedule

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

tags

@Stability(Stable)
public CfnTask.Builder tags(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-tags

taskReportConfig

@Stability(Stable)
public CfnTask.Builder taskReportConfig(IResolvable taskReportConfig)

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

For more information, see Monitoring your DataSync transfers with task reports .

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

Parameters:

taskReportConfig - Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig

taskReportConfig

@Stability(Stable)
public CfnTask.Builder taskReportConfig(CfnTask.TaskReportConfigProperty taskReportConfig)

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

For more information, see Monitoring your DataSync transfers with task reports .

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

Parameters:

taskReportConfig - Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig

build

@Stability(Stable)
public CfnTask build()

Specified by:

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

Returns:

a newly built instance of CfnTask.