Interface CreateTaskRequest.Builder

    • Method Detail

      • sourceLocationArn

        CreateTaskRequest.Builder sourceLocationArn​(String sourceLocationArn)

        Specifies the ARN of your transfer's source location.

        Parameters:
        sourceLocationArn - Specifies the ARN of your transfer's source location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • destinationLocationArn

        CreateTaskRequest.Builder destinationLocationArn​(String destinationLocationArn)

        Specifies the ARN of your transfer's destination location.

        Parameters:
        destinationLocationArn - Specifies the ARN of your transfer's destination location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • cloudWatchLogGroupArn

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

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • name

        CreateTaskRequest.Builder name​(String name)

        Specifies the name of your task.

        Parameters:
        name - Specifies the name of your task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • options

        CreateTaskRequest.Builder options​(Options 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • schedule

        CreateTaskRequest.Builder schedule​(TaskSchedule 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. For more information, see Scheduling your task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        CreateTaskRequest.Builder tags​(Collection<TagListEntry> 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.

        Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        CreateTaskRequest.Builder tags​(TagListEntry... 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.

        Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • manifestConfig

        CreateTaskRequest.Builder manifestConfig​(ManifestConfig manifestConfig)

        Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

        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:
        manifestConfig - Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • taskReportConfig

        CreateTaskRequest.Builder taskReportConfig​(TaskReportConfig 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. 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • taskMode

        CreateTaskRequest.Builder taskMode​(String taskMode)

        Specifies one of the following task modes for your data transfer:

        • ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

          To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

        • BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

        For more information, see Understanding task mode differences.

        Parameters:
        taskMode - Specifies one of the following task modes for your data transfer:

        • ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

          To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

        • BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

        For more information, see Understanding task mode differences.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskMode, TaskMode
      • taskMode

        CreateTaskRequest.Builder taskMode​(TaskMode taskMode)

        Specifies one of the following task modes for your data transfer:

        • ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

          To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

        • BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

        For more information, see Understanding task mode differences.

        Parameters:
        taskMode - Specifies one of the following task modes for your data transfer:

        • ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

          To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

        • BASIC (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

        For more information, see Understanding task mode differences.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskMode, TaskMode