Struct aws_sdk_datasync::client::fluent_builders::CreateTask

pub struct CreateTask<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateTask.

Creates a task.

A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.

When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.

You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.

When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.

Implementations

impl<C, M, R> CreateTask<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<CreateTaskOutput, SdkError<CreateTaskError>> where
    R::Policy: SmithyRetryPolicy<CreateTaskInputOperationOutputAlias, CreateTaskOutput, CreateTaskError, CreateTaskInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn source_location_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the source location for the task.

pub fn set_source_location_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the source location for the task.

pub fn destination_location_arn(self, input: impl Into<String>) -> Self

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

pub fn set_destination_location_arn(self, input: Option<String>) -> Self

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

pub fn cloud_watch_log_group_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

pub fn set_cloud_watch_log_group_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

pub fn name(self, input: impl Into<String>) -> Self

The name of a task. This value is a text reference that is used to identify the task in the console.

pub fn set_name(self, input: Option<String>) -> Self

The name of a task. This value is a text reference that is used to identify the task in the console.

pub fn options(self, input: Options) -> Self

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

pub fn set_options(self, input: Option<Options>) -> Self

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

pub fn excludes(self, input: FilterRule) -> Self

Appends an item to Excludes.

To override the contents of this collection use set_excludes.

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

pub fn set_excludes(self, input: Option<Vec<FilterRule>>) -> Self

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

pub fn schedule(self, input: TaskSchedule) -> Self

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.

pub fn set_schedule(self, input: Option<TaskSchedule>) -> Self

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.

pub fn tags(self, input: TagListEntry) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

pub fn set_tags(self, input: Option<Vec<TagListEntry>>) -> Self

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

pub fn includes(self, input: FilterRule) -> Self

Appends an item to Includes.

To override the contents of this collection use set_includes.

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

pub fn set_includes(self, input: Option<Vec<FilterRule>>) -> Self

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateTask<C, M, R>

fn clone(&self) -> CreateTask<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateTask<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.