Package software.amazon.awssdk.services.datasync.model

Interface CreateTaskRequest.Builder

    • Method Detail

      • sourceLocationArn

        CreateTaskRequest.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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationLocationArn

        CreateTaskRequest.Builder destinationLocationArn​(String destinationLocationArn)

        The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

        Parameters:
        destinationLocationArn - The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudWatchLogGroupArn

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

        Parameters:
        cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        CreateTaskRequest.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 value is a text reference that is used to identify the task in the console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • options

        CreateTaskRequest.Builder options​(Options 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.

        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.

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

      • schedule

        CreateTaskRequest.Builder schedule​(TaskSchedule 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. The schedule should be specified in UTC time. 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 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.

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

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

        This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on TagListEntry.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

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