Package software.amazon.awscdk.mixins.preview.services.datasync.mixins

Class CfnTaskPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.datasync.mixins.CfnTaskPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskPropsMixin>

Enclosing class:

CfnTaskPropsMixin

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

A fluent builder for CfnTaskPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTaskPropsMixin	build()
CfnTaskPropsMixin.Builder	cloudWatchLogGroupArn(String cloudWatchLogGroupArn)	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
static CfnTaskPropsMixin.Builder	create()
static CfnTaskPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTaskPropsMixin.Builder	destinationLocationArn(String destinationLocationArn)	The Amazon Resource Name (ARN) of an AWS storage resource's location.
CfnTaskPropsMixin.Builder	excludes(List<? extends Object> excludes)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
CfnTaskPropsMixin.Builder	excludes(IResolvable excludes)	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
CfnTaskPropsMixin.Builder	includes(List<? extends Object> includes)	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
CfnTaskPropsMixin.Builder	includes(IResolvable includes)	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
CfnTaskPropsMixin.Builder	manifestConfig(IResolvable manifestConfig)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
CfnTaskPropsMixin.Builder	manifestConfig(CfnTaskPropsMixin.ManifestConfigProperty manifestConfig)	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
CfnTaskPropsMixin.Builder	name(String name)	Specifies the name of your task.
CfnTaskPropsMixin.Builder	options(IResolvable options)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
CfnTaskPropsMixin.Builder	options(CfnTaskPropsMixin.OptionsProperty options)	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
CfnTaskPropsMixin.Builder	schedule(IResolvable schedule)	Specifies a schedule for when you want your task to run.
CfnTaskPropsMixin.Builder	schedule(CfnTaskPropsMixin.TaskScheduleProperty schedule)	Specifies a schedule for when you want your task to run.
CfnTaskPropsMixin.Builder	sourceLocationArn(String sourceLocationArn)	Specifies the ARN of your transfer's source location.
CfnTaskPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Specifies the tags that you want to apply to your task.
CfnTaskPropsMixin.Builder	taskMode(String taskMode)	The task mode that you're using.
CfnTaskPropsMixin.Builder	taskReportConfig(IResolvable taskReportConfig)	The configuration of your task report, which provides detailed information about your DataSync transfer.
CfnTaskPropsMixin.Builder	taskReportConfig(CfnTaskPropsMixin.TaskReportConfigProperty taskReportConfig)	The configuration of your 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 CfnTaskPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTaskPropsMixin.Builder.

create

@Stability(Stable)
public static CfnTaskPropsMixin.Builder create()

Returns:

a new instance of CfnTaskPropsMixin.Builder.

cloudWatchLogGroupArn

@Stability(Stable)
public CfnTaskPropsMixin.Builder cloudWatchLogGroupArn(String cloudWatchLogGroupArn)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync .

For more information, see Monitoring data transfers with CloudWatch Logs .

Parameters:

cloudWatchLogGroupArn - Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your 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

destinationLocationArn

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

excludes

@Stability(Stable)
public CfnTaskPropsMixin.Builder excludes(IResolvable excludes)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Parameters:

excludes - Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync 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-excludes

excludes

@Stability(Stable)
public CfnTaskPropsMixin.Builder excludes(List<? extends Object> excludes)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Parameters:

excludes - Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync 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-excludes

includes

@Stability(Stable)
public CfnTaskPropsMixin.Builder includes(IResolvable includes)

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Parameters:

includes - Specifies include filters that define the files, objects, and folders in your source location that you want DataSync 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-includes

includes

@Stability(Stable)
public CfnTaskPropsMixin.Builder includes(List<? extends Object> includes)

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

Parameters:

includes - Specifies include filters that define the files, objects, and folders in your source location that you want DataSync 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-includes

manifestConfig

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

The configuration of the manifest that lists the files or objects that you want DataSync 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 that you want DataSync 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 CfnTaskPropsMixin.Builder manifestConfig(CfnTaskPropsMixin.ManifestConfigProperty manifestConfig)

The configuration of the manifest that lists the files or objects that you want DataSync 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 that you want DataSync 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 CfnTaskPropsMixin.Builder name(String name)

Specifies the name of your task.

Parameters:

name - Specifies the name of your 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 CfnTaskPropsMixin.Builder options(IResolvable options)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Parameters:

options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options. 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 CfnTaskPropsMixin.Builder options(CfnTaskPropsMixin.OptionsProperty options)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

Parameters:

options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options. 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 CfnTaskPropsMixin.Builder schedule(IResolvable schedule)

Specifies a schedule for when you want your task to run.

For more information, see Scheduling your task .

Parameters:

schedule - Specifies a schedule for when you want your task to run. 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 CfnTaskPropsMixin.Builder schedule(CfnTaskPropsMixin.TaskScheduleProperty schedule)

Specifies a schedule for when you want your task to run.

For more information, see Scheduling your task .

Parameters:

schedule - Specifies a schedule for when you want your task to run. 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

sourceLocationArn

@Stability(Stable)
public CfnTaskPropsMixin.Builder sourceLocationArn(String sourceLocationArn)

Specifies the ARN of your transfer's source location.

Parameters:

sourceLocationArn - Specifies the ARN of your transfer's source 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-sourcelocationarn

tags

@Stability(Stable)
public CfnTaskPropsMixin.Builder tags(List<? extends CfnTag> tags)

Specifies the tags that you want to apply to your 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 your 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

taskMode

@Stability(Stable)
public CfnTaskPropsMixin.Builder taskMode(String taskMode)

The task mode that you're using.

For more information, see Choosing a task mode for your data transfer .

Parameters:

taskMode - The task mode that you're using. This parameter is required.

Returns:

this

See Also:

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

taskReportConfig

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

The configuration of your task report, which provides detailed information about your DataSync transfer.

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

Parameters:

taskReportConfig - The configuration of your 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 CfnTaskPropsMixin.Builder taskReportConfig(CfnTaskPropsMixin.TaskReportConfigProperty taskReportConfig)

The configuration of your task report, which provides detailed information about your DataSync transfer.

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

Parameters:

taskReportConfig - The configuration of your 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 CfnTaskPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnTaskPropsMixin.