Class CfnTask.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTask>
- Enclosing class:
CfnTask
CfnTask
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
cloudWatchLogGroupArn
(String cloudWatchLogGroupArn) Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.static CfnTask.Builder
destinationLocationArn
(String destinationLocationArn) The Amazon Resource Name (ARN) of an AWS storage resource's location.Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.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.Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.includes
(IResolvable includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.manifestConfig
(IResolvable manifestConfig) The configuration of the manifest that lists the files or objects that you want DataSync to transfer.manifestConfig
(CfnTask.ManifestConfigProperty manifestConfig) The configuration of the manifest that lists the files or objects that you want DataSync to transfer.Specifies the name of your task.options
(IResolvable options) Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.options
(CfnTask.OptionsProperty options) Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.schedule
(IResolvable schedule) Specifies a schedule for when you want your task to run.schedule
(CfnTask.TaskScheduleProperty schedule) Specifies a schedule for when you want your task to run.sourceLocationArn
(String sourceLocationArn) Specifies the ARN of your transfer's source location.Specifies the tags that you want to apply to your task.taskReportConfig
(IResolvable taskReportConfig) Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.taskReportConfig
(CfnTask.TaskReportConfigProperty taskReportConfig) Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
-
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
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:
-
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:
-
cloudWatchLogGroupArn
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.For more information, see Monitoring DataSync with Amazon CloudWatch .
- 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:
-
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:
-
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:
-
includes
Specifies include filters 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 define the files, objects, and folders in your source location that you want DataSync to transfer. This parameter is required.- Returns:
this
- See Also:
-
includes
Specifies include filters 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 define the files, objects, and folders in your source location that you want DataSync to transfer. This parameter is required.- Returns:
this
- See Also:
-
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:
-
manifestConfig
@Stability(Stable) public CfnTask.Builder manifestConfig(CfnTask.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:
-
name
Specifies the name of your task.- Parameters:
name
- Specifies the name of your task. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
build
-