Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datasync
  5. getTask

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.datasync.getTask

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::DataSync::Task.

Using getTask

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTask(args: GetTaskArgs, opts?: InvokeOptions): Promise<GetTaskResult>
function getTaskOutput(args: GetTaskOutputArgs, opts?: InvokeOptions): Output<GetTaskResult>
Copy
def get_task(task_arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetTaskResult
def get_task_output(task_arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetTaskResult]
Copy
func LookupTask(ctx *Context, args *LookupTaskArgs, opts ...InvokeOption) (*LookupTaskResult, error)
func LookupTaskOutput(ctx *Context, args *LookupTaskOutputArgs, opts ...InvokeOption) LookupTaskResultOutput
Copy

> Note: This function is named LookupTask in the Go SDK.

public static class GetTask 
{
    public static Task<GetTaskResult> InvokeAsync(GetTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetTaskResult> Invoke(GetTaskInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
public static Output<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:datasync:getTask
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

TaskArn This property is required. string
The ARN of the task.
TaskArn This property is required. string
The ARN of the task.
taskArn This property is required. String
The ARN of the task.
taskArn This property is required. string
The ARN of the task.
task_arn This property is required. str
The ARN of the task.
taskArn This property is required. String
The ARN of the task.

getTask Result

The following output properties are available:

CloudWatchLogGroupArn string
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationNetworkInterfaceArns List<string>
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
Excludes List<Pulumi.AwsNative.DataSync.Outputs.TaskFilterRule>
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 .
Includes List<Pulumi.AwsNative.DataSync.Outputs.TaskFilterRule>
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 .
ManifestConfig Pulumi.AwsNative.DataSync.Outputs.TaskManifestConfig
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 .
Name string
The name of a task. This value is a text reference that is used to identify the task in the console.
Options Pulumi.AwsNative.DataSync.Outputs.TaskOptions
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
Schedule Pulumi.AwsNative.DataSync.Outputs.TaskSchedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
SourceNetworkInterfaceArns List<string>
The ARNs of the source ENIs that were created for your subnet.
Status Pulumi.AwsNative.DataSync.TaskStatus
The status of the task that was described.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
TaskArn string
The ARN of the task.
TaskReportConfig Pulumi.AwsNative.DataSync.Outputs.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.

CloudWatchLogGroupArn string
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationNetworkInterfaceArns []string
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
Excludes []TaskFilterRule
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 .
Includes []TaskFilterRule
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 .
ManifestConfig TaskManifestConfig
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 .
Name string
The name of a task. This value is a text reference that is used to identify the task in the console.
Options TaskOptions
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
Schedule TaskSchedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
SourceNetworkInterfaceArns []string
The ARNs of the source ENIs that were created for your subnet.
Status TaskStatus
The status of the task that was described.
Tags Tag
An array of key-value pairs to apply to this resource.
TaskArn string
The ARN of the task.
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.

cloudWatchLogGroupArn String
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns List<String>
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
excludes List<TaskFilterRule>
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 .
includes List<TaskFilterRule>
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 .
manifestConfig TaskManifestConfig
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 .
name String
The name of a task. This value is a text reference that is used to identify the task in the console.
options TaskOptions
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule TaskSchedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
sourceNetworkInterfaceArns List<String>
The ARNs of the source ENIs that were created for your subnet.
status TaskStatus
The status of the task that was described.
tags List<Tag>
An array of key-value pairs to apply to this resource.
taskArn String
The ARN of the task.
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.

cloudWatchLogGroupArn string
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns string[]
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
excludes TaskFilterRule[]
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 .
includes TaskFilterRule[]
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 .
manifestConfig TaskManifestConfig
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 .
name string
The name of a task. This value is a text reference that is used to identify the task in the console.
options TaskOptions
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule TaskSchedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
sourceNetworkInterfaceArns string[]
The ARNs of the source ENIs that were created for your subnet.
status TaskStatus
The status of the task that was described.
tags Tag[]
An array of key-value pairs to apply to this resource.
taskArn string
The ARN of the task.
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.

cloud_watch_log_group_arn str
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destination_network_interface_arns Sequence[str]
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
excludes Sequence[TaskFilterRule]
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 .
includes Sequence[TaskFilterRule]
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 .
manifest_config TaskManifestConfig
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 .
name str
The name of a task. This value is a text reference that is used to identify the task in the console.
options TaskOptions
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule TaskSchedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
source_network_interface_arns Sequence[str]
The ARNs of the source ENIs that were created for your subnet.
status TaskStatus
The status of the task that was described.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
task_arn str
The ARN of the task.
task_report_config 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.

cloudWatchLogGroupArn String
The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns List<String>
The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
excludes List<Property Map>
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 .
includes List<Property Map>
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 .
manifestConfig Property Map
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 .
name String
The name of a task. This value is a text reference that is used to identify the task in the console.
options Property Map
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule Property Map
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
sourceNetworkInterfaceArns List<String>
The ARNs of the source ENIs that were created for your subnet.
status "AVAILABLE" | "CREATING" | "QUEUED" | "RUNNING" | "UNAVAILABLE"
The status of the task that was described.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
taskArn String
The ARN of the task.
taskReportConfig Property Map

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.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

TaskFilterRule

FilterType Pulumi.AwsNative.DataSync.TaskFilterRuleFilterType
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value string
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".
FilterType TaskFilterRuleFilterType
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
Value string
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".
filterType TaskFilterRuleFilterType
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
value String
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".
filterType TaskFilterRuleFilterType
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
value string
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".
filter_type TaskFilterRuleFilterType
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
value str
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".
filterType "SIMPLE_PATTERN"
The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
value String
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".

TaskFilterRuleFilterType

TaskManifestConfig

Source This property is required. Pulumi.AwsNative.DataSync.Inputs.TaskManifestConfigSourceProperties
Specifies the manifest that you want DataSync to use and where it's hosted.
Action Pulumi.AwsNative.DataSync.TaskManifestConfigAction
Specifies what DataSync uses the manifest for.
Format Pulumi.AwsNative.DataSync.TaskManifestConfigFormat
Specifies the file format of your manifest.
Source This property is required. TaskManifestConfigSourceProperties
Specifies the manifest that you want DataSync to use and where it's hosted.
Action TaskManifestConfigAction
Specifies what DataSync uses the manifest for.
Format TaskManifestConfigFormat
Specifies the file format of your manifest.
source This property is required. TaskManifestConfigSourceProperties
Specifies the manifest that you want DataSync to use and where it's hosted.
action TaskManifestConfigAction
Specifies what DataSync uses the manifest for.
format TaskManifestConfigFormat
Specifies the file format of your manifest.
source This property is required. TaskManifestConfigSourceProperties
Specifies the manifest that you want DataSync to use and where it's hosted.
action TaskManifestConfigAction
Specifies what DataSync uses the manifest for.
format TaskManifestConfigFormat
Specifies the file format of your manifest.
source This property is required. TaskManifestConfigSourceProperties
Specifies the manifest that you want DataSync to use and where it's hosted.
action TaskManifestConfigAction
Specifies what DataSync uses the manifest for.
format TaskManifestConfigFormat
Specifies the file format of your manifest.
source This property is required. Property Map
Specifies the manifest that you want DataSync to use and where it's hosted.
action "TRANSFER"
Specifies what DataSync uses the manifest for.
format "CSV"
Specifies the file format of your manifest.

TaskManifestConfigAction

TaskManifestConfigFormat

TaskManifestConfigSourceProperties

TaskManifestConfigSourceS3

BucketAccessRoleArn string
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
ManifestObjectPath string
Specifies the Amazon S3 object key of your manifest.
ManifestObjectVersionId string
Specifies the object version ID of the manifest that you want DataSync to use.
S3BucketArn string
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
BucketAccessRoleArn string
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
ManifestObjectPath string
Specifies the Amazon S3 object key of your manifest.
ManifestObjectVersionId string
Specifies the object version ID of the manifest that you want DataSync to use.
S3BucketArn string
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
bucketAccessRoleArn String
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
manifestObjectPath String
Specifies the Amazon S3 object key of your manifest.
manifestObjectVersionId String
Specifies the object version ID of the manifest that you want DataSync to use.
s3BucketArn String
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
bucketAccessRoleArn string
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
manifestObjectPath string
Specifies the Amazon S3 object key of your manifest.
manifestObjectVersionId string
Specifies the object version ID of the manifest that you want DataSync to use.
s3BucketArn string
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
bucket_access_role_arn str
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
manifest_object_path str
Specifies the Amazon S3 object key of your manifest.
manifest_object_version_id str
Specifies the object version ID of the manifest that you want DataSync to use.
s3_bucket_arn str
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
bucketAccessRoleArn String
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
manifestObjectPath String
Specifies the Amazon S3 object key of your manifest.
manifestObjectVersionId String
Specifies the object version ID of the manifest that you want DataSync to use.
s3BucketArn String
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

TaskOptions

Atime Pulumi.AwsNative.DataSync.TaskOptionsAtime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
BytesPerSecond int
A value that limits the bandwidth used by AWS DataSync.
Gid Pulumi.AwsNative.DataSync.TaskOptionsGid
The group ID (GID) of the file's owners.
LogLevel Pulumi.AwsNative.DataSync.TaskOptionsLogLevel
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
Mtime Pulumi.AwsNative.DataSync.TaskOptionsMtime
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
ObjectTags Pulumi.AwsNative.DataSync.TaskOptionsObjectTags
A value that determines whether object tags should be read from the source object store and written to the destination object store.
OverwriteMode Pulumi.AwsNative.DataSync.TaskOptionsOverwriteMode
A value that determines whether files at the destination should be overwritten or preserved when copying files.
PosixPermissions Pulumi.AwsNative.DataSync.TaskOptionsPosixPermissions
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
PreserveDeletedFiles Pulumi.AwsNative.DataSync.TaskOptionsPreserveDeletedFiles
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
PreserveDevices Pulumi.AwsNative.DataSync.TaskOptionsPreserveDevices
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
SecurityDescriptorCopyFlags Pulumi.AwsNative.DataSync.TaskOptionsSecurityDescriptorCopyFlags
A value that determines which components of the SMB security descriptor are copied during transfer.
TaskQueueing Pulumi.AwsNative.DataSync.TaskOptionsTaskQueueing
A value that determines whether tasks should be queued before executing the tasks.
TransferMode Pulumi.AwsNative.DataSync.TaskOptionsTransferMode
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
Uid Pulumi.AwsNative.DataSync.TaskOptionsUid
The user ID (UID) of the file's owner.
VerifyMode Pulumi.AwsNative.DataSync.TaskOptionsVerifyMode
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
Atime TaskOptionsAtime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
BytesPerSecond int
A value that limits the bandwidth used by AWS DataSync.
Gid TaskOptionsGid
The group ID (GID) of the file's owners.
LogLevel TaskOptionsLogLevel
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
Mtime TaskOptionsMtime
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
ObjectTags TaskOptionsObjectTags
A value that determines whether object tags should be read from the source object store and written to the destination object store.
OverwriteMode TaskOptionsOverwriteMode
A value that determines whether files at the destination should be overwritten or preserved when copying files.
PosixPermissions TaskOptionsPosixPermissions
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
PreserveDeletedFiles TaskOptionsPreserveDeletedFiles
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
PreserveDevices TaskOptionsPreserveDevices
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
SecurityDescriptorCopyFlags TaskOptionsSecurityDescriptorCopyFlags
A value that determines which components of the SMB security descriptor are copied during transfer.
TaskQueueing TaskOptionsTaskQueueing
A value that determines whether tasks should be queued before executing the tasks.
TransferMode TaskOptionsTransferMode
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
Uid TaskOptionsUid
The user ID (UID) of the file's owner.
VerifyMode TaskOptionsVerifyMode
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
atime TaskOptionsAtime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
bytesPerSecond Integer
A value that limits the bandwidth used by AWS DataSync.
gid TaskOptionsGid
The group ID (GID) of the file's owners.
logLevel TaskOptionsLogLevel
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
mtime TaskOptionsMtime
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
objectTags TaskOptionsObjectTags
A value that determines whether object tags should be read from the source object store and written to the destination object store.
overwriteMode TaskOptionsOverwriteMode
A value that determines whether files at the destination should be overwritten or preserved when copying files.
posixPermissions TaskOptionsPosixPermissions
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
preserveDeletedFiles TaskOptionsPreserveDeletedFiles
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
preserveDevices TaskOptionsPreserveDevices
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
securityDescriptorCopyFlags TaskOptionsSecurityDescriptorCopyFlags
A value that determines which components of the SMB security descriptor are copied during transfer.
taskQueueing TaskOptionsTaskQueueing
A value that determines whether tasks should be queued before executing the tasks.
transferMode TaskOptionsTransferMode
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
uid TaskOptionsUid
The user ID (UID) of the file's owner.
verifyMode TaskOptionsVerifyMode
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
atime TaskOptionsAtime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
bytesPerSecond number
A value that limits the bandwidth used by AWS DataSync.
gid TaskOptionsGid
The group ID (GID) of the file's owners.
logLevel TaskOptionsLogLevel
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
mtime TaskOptionsMtime
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
objectTags TaskOptionsObjectTags
A value that determines whether object tags should be read from the source object store and written to the destination object store.
overwriteMode TaskOptionsOverwriteMode
A value that determines whether files at the destination should be overwritten or preserved when copying files.
posixPermissions TaskOptionsPosixPermissions
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
preserveDeletedFiles TaskOptionsPreserveDeletedFiles
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
preserveDevices TaskOptionsPreserveDevices
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
securityDescriptorCopyFlags TaskOptionsSecurityDescriptorCopyFlags
A value that determines which components of the SMB security descriptor are copied during transfer.
taskQueueing TaskOptionsTaskQueueing
A value that determines whether tasks should be queued before executing the tasks.
transferMode TaskOptionsTransferMode
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
uid TaskOptionsUid
The user ID (UID) of the file's owner.
verifyMode TaskOptionsVerifyMode
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
atime TaskOptionsAtime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
bytes_per_second int
A value that limits the bandwidth used by AWS DataSync.
gid TaskOptionsGid
The group ID (GID) of the file's owners.
log_level TaskOptionsLogLevel
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
mtime TaskOptionsMtime
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
object_tags TaskOptionsObjectTags
A value that determines whether object tags should be read from the source object store and written to the destination object store.
overwrite_mode TaskOptionsOverwriteMode
A value that determines whether files at the destination should be overwritten or preserved when copying files.
posix_permissions TaskOptionsPosixPermissions
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
preserve_deleted_files TaskOptionsPreserveDeletedFiles
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
preserve_devices TaskOptionsPreserveDevices
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
security_descriptor_copy_flags TaskOptionsSecurityDescriptorCopyFlags
A value that determines which components of the SMB security descriptor are copied during transfer.
task_queueing TaskOptionsTaskQueueing
A value that determines whether tasks should be queued before executing the tasks.
transfer_mode TaskOptionsTransferMode
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
uid TaskOptionsUid
The user ID (UID) of the file's owner.
verify_mode TaskOptionsVerifyMode
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.
atime "NONE" | "BEST_EFFORT"
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).
bytesPerSecond Number
A value that limits the bandwidth used by AWS DataSync.
gid "NONE" | "INT_VALUE" | "NAME" | "BOTH"
The group ID (GID) of the file's owners.
logLevel "OFF" | "BASIC" | "TRANSFER"
A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.
mtime "NONE" | "PRESERVE"
A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
objectTags "PRESERVE" | "NONE"
A value that determines whether object tags should be read from the source object store and written to the destination object store.
overwriteMode "ALWAYS" | "NEVER"
A value that determines whether files at the destination should be overwritten or preserved when copying files.
posixPermissions "NONE" | "PRESERVE"
A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
preserveDeletedFiles "PRESERVE" | "REMOVE"
A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
preserveDevices "NONE" | "PRESERVE"
A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
securityDescriptorCopyFlags "NONE" | "OWNER_DACL" | "OWNER_DACL_SACL"
A value that determines which components of the SMB security descriptor are copied during transfer.
taskQueueing "ENABLED" | "DISABLED"
A value that determines whether tasks should be queued before executing the tasks.
transferMode "CHANGED" | "ALL"
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
uid "NONE" | "INT_VALUE" | "NAME" | "BOTH"
The user ID (UID) of the file's owner.
verifyMode "POINT_IN_TIME_CONSISTENT" | "ONLY_FILES_TRANSFERRED" | "NONE"
A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

TaskOptionsAtime

TaskOptionsGid

TaskOptionsLogLevel

TaskOptionsMtime

TaskOptionsObjectTags

TaskOptionsOverwriteMode

TaskOptionsPosixPermissions

TaskOptionsPreserveDeletedFiles

TaskOptionsPreserveDevices

TaskOptionsSecurityDescriptorCopyFlags

TaskOptionsTaskQueueing

TaskOptionsTransferMode

TaskOptionsUid

TaskOptionsVerifyMode

TaskReportConfig

Destination This property is required. Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigDestinationProperties
Specifies where DataSync uploads your task report.
OutputType This property is required. Pulumi.AwsNative.DataSync.TaskReportConfigOutputType
Specifies the type of task report that you want.
ObjectVersionIds Pulumi.AwsNative.DataSync.TaskReportConfigObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
Overrides Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigOverridesProperties
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
ReportLevel Pulumi.AwsNative.DataSync.TaskReportConfigReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
Destination This property is required. TaskReportConfigDestinationProperties
Specifies where DataSync uploads your task report.
OutputType This property is required. TaskReportConfigOutputType
Specifies the type of task report that you want.
ObjectVersionIds TaskReportConfigObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
Overrides TaskReportConfigOverridesProperties
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
ReportLevel TaskReportConfigReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
destination This property is required. TaskReportConfigDestinationProperties
Specifies where DataSync uploads your task report.
outputType This property is required. TaskReportConfigOutputType
Specifies the type of task report that you want.
objectVersionIds TaskReportConfigObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
overrides TaskReportConfigOverridesProperties
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
reportLevel TaskReportConfigReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
destination This property is required. TaskReportConfigDestinationProperties
Specifies where DataSync uploads your task report.
outputType This property is required. TaskReportConfigOutputType
Specifies the type of task report that you want.
objectVersionIds TaskReportConfigObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
overrides TaskReportConfigOverridesProperties
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
reportLevel TaskReportConfigReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
destination This property is required. TaskReportConfigDestinationProperties
Specifies where DataSync uploads your task report.
output_type This property is required. TaskReportConfigOutputType
Specifies the type of task report that you want.
object_version_ids TaskReportConfigObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
overrides TaskReportConfigOverridesProperties
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
report_level TaskReportConfigReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
destination This property is required. Property Map
Specifies where DataSync uploads your task report.
outputType This property is required. "SUMMARY_ONLY" | "STANDARD"
Specifies the type of task report that you want.
objectVersionIds "INCLUDE" | "NONE"
Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.
overrides Property Map
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.
reportLevel "ERRORS_ONLY" | "SUCCESSES_AND_ERRORS"
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

TaskReportConfigDestinationProperties

TaskReportConfigDestinationS3

BucketAccessRoleArn string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
S3BucketArn string
Specifies the ARN of the S3 bucket where Datasync uploads your report.
Subdirectory string
Specifies a bucket prefix for your report.
BucketAccessRoleArn string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
S3BucketArn string
Specifies the ARN of the S3 bucket where Datasync uploads your report.
Subdirectory string
Specifies a bucket prefix for your report.
bucketAccessRoleArn String
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
s3BucketArn String
Specifies the ARN of the S3 bucket where Datasync uploads your report.
subdirectory String
Specifies a bucket prefix for your report.
bucketAccessRoleArn string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
s3BucketArn string
Specifies the ARN of the S3 bucket where Datasync uploads your report.
subdirectory string
Specifies a bucket prefix for your report.
bucket_access_role_arn str
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
s3_bucket_arn str
Specifies the ARN of the S3 bucket where Datasync uploads your report.
subdirectory str
Specifies a bucket prefix for your report.
bucketAccessRoleArn String
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
s3BucketArn String
Specifies the ARN of the S3 bucket where Datasync uploads your report.
subdirectory String
Specifies a bucket prefix for your report.

TaskReportConfigObjectVersionIds

TaskReportConfigOutputType

TaskReportConfigOverridesProperties

Deleted Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigOverridesPropertiesDeletedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
Skipped Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigOverridesPropertiesSkippedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
Transferred Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigOverridesPropertiesTransferredProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
Verified Pulumi.AwsNative.DataSync.Inputs.TaskReportConfigOverridesPropertiesVerifiedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
Deleted TaskReportConfigOverridesPropertiesDeletedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
Skipped TaskReportConfigOverridesPropertiesSkippedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
Transferred TaskReportConfigOverridesPropertiesTransferredProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
Verified TaskReportConfigOverridesPropertiesVerifiedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
deleted TaskReportConfigOverridesPropertiesDeletedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
skipped TaskReportConfigOverridesPropertiesSkippedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
transferred TaskReportConfigOverridesPropertiesTransferredProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
verified TaskReportConfigOverridesPropertiesVerifiedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
deleted TaskReportConfigOverridesPropertiesDeletedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
skipped TaskReportConfigOverridesPropertiesSkippedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
transferred TaskReportConfigOverridesPropertiesTransferredProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
verified TaskReportConfigOverridesPropertiesVerifiedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
deleted TaskReportConfigOverridesPropertiesDeletedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
skipped TaskReportConfigOverridesPropertiesSkippedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
transferred TaskReportConfigOverridesPropertiesTransferredProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
verified TaskReportConfigOverridesPropertiesVerifiedProperties
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
deleted Property Map
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.
skipped Property Map
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
transferred Property Map
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
verified Property Map
Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)

TaskReportConfigOverridesPropertiesDeletedProperties

ReportLevel Pulumi.AwsNative.DataSync.TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
ReportLevel TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
report_level TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel "ERRORS_ONLY" | "SUCCESSES_AND_ERRORS"
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel

TaskReportConfigOverridesPropertiesSkippedProperties

ReportLevel Pulumi.AwsNative.DataSync.TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
ReportLevel TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
report_level TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel "ERRORS_ONLY" | "SUCCESSES_AND_ERRORS"
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel

TaskReportConfigOverridesPropertiesTransferredProperties

ReportLevel Pulumi.AwsNative.DataSync.TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
ReportLevel TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
report_level TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel "ERRORS_ONLY" | "SUCCESSES_AND_ERRORS"
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel

TaskReportConfigOverridesPropertiesVerifiedProperties

ReportLevel Pulumi.AwsNative.DataSync.TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
ReportLevel TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
report_level TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
reportLevel "ERRORS_ONLY" | "SUCCESSES_AND_ERRORS"
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel

TaskReportConfigReportLevel

TaskSchedule

ScheduleExpression string
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
Status Pulumi.AwsNative.DataSync.TaskScheduleStatus
Specifies status of a schedule.
ScheduleExpression string
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
Status TaskScheduleStatus
Specifies status of a schedule.
scheduleExpression String
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
status TaskScheduleStatus
Specifies status of a schedule.
scheduleExpression string
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
status TaskScheduleStatus
Specifies status of a schedule.
schedule_expression str
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
status TaskScheduleStatus
Specifies status of a schedule.
scheduleExpression String
A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
status "ENABLED" | "DISABLED"
Specifies status of a schedule.

TaskScheduleStatus

TaskStatus

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native