We recommend new projects start with resources from the AWS provider.
aws-native.datasync.getTask
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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>
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]
func LookupTask(ctx *Context, args *LookupTaskArgs, opts ...InvokeOption) (*LookupTaskResult, error)
func LookupTaskOutput(ctx *Context, args *LookupTaskOutputArgs, opts ...InvokeOption) LookupTaskResultOutput
> 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)
}
public static CompletableFuture<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:datasync:getTask
arguments:
# arguments dictionary
The following arguments are supported:
- Task
Arn string - The ARN of the task.
- Task
Arn string - The ARN of the task.
- task
Arn String - The ARN of the task.
- task
Arn string - The ARN of the task.
- task_
arn str - The ARN of the task.
- task
Arn String - The ARN of the task.
getTask Result
The following output properties are available:
- Cloud
Watch stringLog Group Arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- Destination
Network List<string>Interface Arns - The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
- Excludes
List<Pulumi.
Aws Native. Data Sync. Outputs. Task Filter Rule> - 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.
Aws Native. Data Sync. Outputs. Task Filter Rule> - 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 Pulumi.Aws Native. Data Sync. Outputs. Task Manifest Config - 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.
Aws Native. Data Sync. Outputs. Task Options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
- Schedule
Pulumi.
Aws Native. Data Sync. Outputs. Task Schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
- Source
Network List<string>Interface Arns - The ARNs of the source ENIs that were created for your subnet.
- Status
Pulumi.
Aws Native. Data Sync. Task Status - The status of the task that was described.
- List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Task
Arn string - The ARN of the task.
- Task
Report Pulumi.Config Aws Native. Data Sync. Outputs. Task Report Config 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 stringLog Group Arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- Destination
Network []stringInterface Arns - The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
- Excludes
[]Task
Filter Rule - 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
[]Task
Filter Rule - 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 TaskManifest Config - 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
Task
Options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
- Schedule
Task
Schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
- Source
Network []stringInterface Arns - The ARNs of the source ENIs that were created for your subnet.
- Status
Task
Status - The status of the task that was described.
- Tag
- An array of key-value pairs to apply to this resource.
- Task
Arn string - The ARN of the task.
- Task
Report TaskConfig Report Config 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 StringLog Group Arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- destination
Network List<String>Interface Arns - The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
- excludes
List<Task
Filter Rule> - 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<Task
Filter Rule> - 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 TaskManifest Config - 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
Task
Options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
- schedule
Task
Schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
- source
Network List<String>Interface Arns - The ARNs of the source ENIs that were created for your subnet.
- status
Task
Status - The status of the task that was described.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- task
Arn String - The ARN of the task.
- task
Report TaskConfig Report Config 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 stringLog Group Arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- destination
Network string[]Interface Arns - The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
- excludes
Task
Filter Rule[] - 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
Task
Filter Rule[] - 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 TaskManifest Config - 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
Task
Options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
- schedule
Task
Schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
- source
Network string[]Interface Arns - The ARNs of the source ENIs that were created for your subnet.
- status
Task
Status - The status of the task that was described.
- Tag[]
- An array of key-value pairs to apply to this resource.
- task
Arn string - The ARN of the task.
- task
Report TaskConfig Report Config 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_ strlog_ group_ arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- destination_
network_ Sequence[str]interface_ arns - The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
- excludes
Sequence[Task
Filter Rule] - 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[Task
Filter Rule] - 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 TaskManifest Config - 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
Task
Options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
- schedule
Task
Schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task .
- source_
network_ Sequence[str]interface_ arns - The ARNs of the source ENIs that were created for your subnet.
- status
Task
Status - The status of the task that was described.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- task_
arn str - The ARN of the task.
- task_
report_ Taskconfig Report Config 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 StringLog Group Arn - The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
- destination
Network List<String>Interface Arns - 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 .
- manifest
Config 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 .
- source
Network List<String>Interface Arns - 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.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- task
Arn String - The ARN of the task.
- task
Report Property MapConfig 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
TaskFilterRule
- Filter
Type Pulumi.Aws Native. Data Sync. Task Filter Rule Filter Type - 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 TaskFilter Rule Filter Type - 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 TaskFilter Rule Filter Type - 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 TaskFilter Rule Filter Type - 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 TaskFilter Rule Filter Type - 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 "|".
- filter
Type "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
Pulumi.
Aws Native. Data Sync. Inputs. Task Manifest Config Source Properties - Specifies the manifest that you want DataSync to use and where it's hosted.
- Action
Pulumi.
Aws Native. Data Sync. Task Manifest Config Action - Specifies what DataSync uses the manifest for.
- Format
Pulumi.
Aws Native. Data Sync. Task Manifest Config Format - Specifies the file format of your manifest.
- Source
Task
Manifest Config Source Properties - Specifies the manifest that you want DataSync to use and where it's hosted.
- Action
Task
Manifest Config Action - Specifies what DataSync uses the manifest for.
- Format
Task
Manifest Config Format - Specifies the file format of your manifest.
- source
Task
Manifest Config Source Properties - Specifies the manifest that you want DataSync to use and where it's hosted.
- action
Task
Manifest Config Action - Specifies what DataSync uses the manifest for.
- format
Task
Manifest Config Format - Specifies the file format of your manifest.
- source
Task
Manifest Config Source Properties - Specifies the manifest that you want DataSync to use and where it's hosted.
- action
Task
Manifest Config Action - Specifies what DataSync uses the manifest for.
- format
Task
Manifest Config Format - Specifies the file format of your manifest.
- source
Task
Manifest Config Source Properties - Specifies the manifest that you want DataSync to use and where it's hosted.
- action
Task
Manifest Config Action - Specifies what DataSync uses the manifest for.
- format
Task
Manifest Config Format - Specifies the file format of your manifest.
- source 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
- Bucket
Access stringRole Arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- Manifest
Object stringPath - Specifies the Amazon S3 object key of your manifest.
- Manifest
Object stringVersion Id - Specifies the object version ID of the manifest that you want DataSync to use.
- S3Bucket
Arn string - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
- Bucket
Access stringRole Arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- Manifest
Object stringPath - Specifies the Amazon S3 object key of your manifest.
- Manifest
Object stringVersion Id - Specifies the object version ID of the manifest that you want DataSync to use.
- S3Bucket
Arn string - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
- bucket
Access StringRole Arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- manifest
Object StringPath - Specifies the Amazon S3 object key of your manifest.
- manifest
Object StringVersion Id - Specifies the object version ID of the manifest that you want DataSync to use.
- s3Bucket
Arn String - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
- bucket
Access stringRole Arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- manifest
Object stringPath - Specifies the Amazon S3 object key of your manifest.
- manifest
Object stringVersion Id - Specifies the object version ID of the manifest that you want DataSync to use.
- s3Bucket
Arn string - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
- bucket_
access_ strrole_ arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- manifest_
object_ strpath - Specifies the Amazon S3 object key of your manifest.
- manifest_
object_ strversion_ id - Specifies the object version ID of the manifest that you want DataSync to use.
- s3_
bucket_ strarn - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
- bucket
Access StringRole Arn - Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
- manifest
Object StringPath - Specifies the Amazon S3 object key of your manifest.
- manifest
Object StringVersion Id - Specifies the object version ID of the manifest that you want DataSync to use.
- s3Bucket
Arn String - Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
TaskOptions
- Atime
Pulumi.
Aws Native. Data Sync. Task Options Atime - 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 intSecond - A value that limits the bandwidth used by AWS DataSync.
- Gid
Pulumi.
Aws Native. Data Sync. Task Options Gid - The group ID (GID) of the file's owners.
- Log
Level Pulumi.Aws Native. Data Sync. Task Options Log Level - 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.
Aws Native. Data Sync. Task Options Mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
- Pulumi.
Aws Native. Data Sync. Task Options Object Tags - A value that determines whether object tags should be read from the source object store and written to the destination object store.
- Overwrite
Mode Pulumi.Aws Native. Data Sync. Task Options Overwrite Mode - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- Posix
Permissions Pulumi.Aws Native. Data Sync. Task Options Posix Permissions - 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 Pulumi.Files Aws Native. Data Sync. Task Options Preserve Deleted Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- Preserve
Devices Pulumi.Aws Native. Data Sync. Task Options Preserve Devices - 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 Pulumi.Copy Flags Aws Native. Data Sync. Task Options Security Descriptor Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- Task
Queueing Pulumi.Aws Native. Data Sync. Task Options Task Queueing - A value that determines whether tasks should be queued before executing the tasks.
- Transfer
Mode Pulumi.Aws Native. Data Sync. Task Options Transfer Mode - 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.
Aws Native. Data Sync. Task Options Uid - The user ID (UID) of the file's owner.
- Verify
Mode Pulumi.Aws Native. Data Sync. Task Options Verify Mode - 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
Task
Options Atime - 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 intSecond - A value that limits the bandwidth used by AWS DataSync.
- Gid
Task
Options Gid - The group ID (GID) of the file's owners.
- Log
Level TaskOptions Log Level - 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
Task
Options Mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
- Task
Options Object Tags - A value that determines whether object tags should be read from the source object store and written to the destination object store.
- Overwrite
Mode TaskOptions Overwrite Mode - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- Posix
Permissions TaskOptions Posix Permissions - 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 TaskFiles Options Preserve Deleted Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- Preserve
Devices TaskOptions Preserve Devices - 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 TaskCopy Flags Options Security Descriptor Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- Task
Queueing TaskOptions Task Queueing - A value that determines whether tasks should be queued before executing the tasks.
- Transfer
Mode TaskOptions Transfer Mode - 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
Task
Options Uid - The user ID (UID) of the file's owner.
- Verify
Mode TaskOptions Verify Mode - 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
Task
Options Atime - 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 IntegerSecond - A value that limits the bandwidth used by AWS DataSync.
- gid
Task
Options Gid - The group ID (GID) of the file's owners.
- log
Level TaskOptions Log Level - 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
Task
Options Mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
- Task
Options Object Tags - A value that determines whether object tags should be read from the source object store and written to the destination object store.
- overwrite
Mode TaskOptions Overwrite Mode - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- posix
Permissions TaskOptions Posix Permissions - 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 TaskFiles Options Preserve Deleted Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- preserve
Devices TaskOptions Preserve Devices - 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 TaskCopy Flags Options Security Descriptor Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- task
Queueing TaskOptions Task Queueing - A value that determines whether tasks should be queued before executing the tasks.
- transfer
Mode TaskOptions Transfer Mode - 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
Task
Options Uid - The user ID (UID) of the file's owner.
- verify
Mode TaskOptions Verify Mode - 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
Task
Options Atime - 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 numberSecond - A value that limits the bandwidth used by AWS DataSync.
- gid
Task
Options Gid - The group ID (GID) of the file's owners.
- log
Level TaskOptions Log Level - 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
Task
Options Mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
- Task
Options Object Tags - A value that determines whether object tags should be read from the source object store and written to the destination object store.
- overwrite
Mode TaskOptions Overwrite Mode - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- posix
Permissions TaskOptions Posix Permissions - 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 TaskFiles Options Preserve Deleted Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- preserve
Devices TaskOptions Preserve Devices - 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 TaskCopy Flags Options Security Descriptor Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- task
Queueing TaskOptions Task Queueing - A value that determines whether tasks should be queued before executing the tasks.
- transfer
Mode TaskOptions Transfer Mode - 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
Task
Options Uid - The user ID (UID) of the file's owner.
- verify
Mode TaskOptions Verify Mode - 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
Task
Options Atime - 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_ intsecond - A value that limits the bandwidth used by AWS DataSync.
- gid
Task
Options Gid - The group ID (GID) of the file's owners.
- log_
level TaskOptions Log Level - 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
Task
Options Mtime - A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
- Task
Options Object Tags - A value that determines whether object tags should be read from the source object store and written to the destination object store.
- overwrite_
mode TaskOptions Overwrite Mode - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- posix_
permissions TaskOptions Posix Permissions - 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_ Taskfiles Options Preserve Deleted Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- preserve_
devices TaskOptions Preserve Devices - 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_ Taskcopy_ flags Options Security Descriptor Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- task_
queueing TaskOptions Task Queueing - A value that determines whether tasks should be queued before executing the tasks.
- transfer_
mode TaskOptions Transfer Mode - 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
Task
Options Uid - The user ID (UID) of the file's owner.
- verify_
mode TaskOptions Verify Mode - 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).
- bytes
Per NumberSecond - 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.
- log
Level "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.
- "PRESERVE" | "NONE"
- A value that determines whether object tags should be read from the source object store and written to the destination object store.
- overwrite
Mode "ALWAYS" | "NEVER" - A value that determines whether files at the destination should be overwritten or preserved when copying files.
- posix
Permissions "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.
- preserve
Deleted "PRESERVE" | "REMOVE"Files - A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
- preserve
Devices "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.
- security
Descriptor "NONE" | "OWNER_DACL" | "OWNER_DACL_SACL"Copy Flags - A value that determines which components of the SMB security descriptor are copied during transfer.
- task
Queueing "ENABLED" | "DISABLED" - A value that determines whether tasks should be queued before executing the tasks.
- transfer
Mode "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.
- verify
Mode "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
Pulumi.
Aws Native. Data Sync. Inputs. Task Report Config Destination Properties - Specifies where DataSync uploads your task report.
- Output
Type Pulumi.Aws Native. Data Sync. Task Report Config Output Type - Specifies the type of task report that you want.
- Object
Version Pulumi.Ids Aws Native. Data Sync. Task Report Config Object Version Ids - 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.
Aws Native. Data Sync. Inputs. Task Report Config Overrides Properties - 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 Pulumi.Aws Native. Data Sync. Task Report Config Report Level - 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
Task
Report Config Destination Properties - Specifies where DataSync uploads your task report.
- Output
Type TaskReport Config Output Type - Specifies the type of task report that you want.
- Object
Version TaskIds Report Config Object Version Ids - 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
Task
Report Config Overrides Properties - 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 TaskReport Config Report Level - 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
Task
Report Config Destination Properties - Specifies where DataSync uploads your task report.
- output
Type TaskReport Config Output Type - Specifies the type of task report that you want.
- object
Version TaskIds Report Config Object Version Ids - 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
Task
Report Config Overrides Properties - 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 TaskReport Config Report Level - 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
Task
Report Config Destination Properties - Specifies where DataSync uploads your task report.
- output
Type TaskReport Config Output Type - Specifies the type of task report that you want.
- object
Version TaskIds Report Config Object Version Ids - 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
Task
Report Config Overrides Properties - 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 TaskReport Config Report Level - 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
Task
Report Config Destination Properties - Specifies where DataSync uploads your task report.
- output_
type TaskReport Config Output Type - Specifies the type of task report that you want.
- object_
version_ Taskids Report Config Object Version Ids - 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
Task
Report Config Overrides Properties - 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 TaskReport Config Report Level - 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 Property Map
- Specifies where DataSync uploads your task report.
- output
Type "SUMMARY_ONLY" | "STANDARD" - Specifies the type of task report that you want.
- object
Version "INCLUDE" | "NONE"Ids - 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.
- report
Level "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
- Bucket
Access stringRole Arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- S3Bucket
Arn string - Specifies the ARN of the S3 bucket where Datasync uploads your report.
- Subdirectory string
- Specifies a bucket prefix for your report.
- Bucket
Access stringRole Arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- S3Bucket
Arn string - Specifies the ARN of the S3 bucket where Datasync uploads your report.
- Subdirectory string
- Specifies a bucket prefix for your report.
- bucket
Access StringRole Arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- s3Bucket
Arn String - Specifies the ARN of the S3 bucket where Datasync uploads your report.
- subdirectory String
- Specifies a bucket prefix for your report.
- bucket
Access stringRole Arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- s3Bucket
Arn string - Specifies the ARN of the S3 bucket where Datasync uploads your report.
- subdirectory string
- Specifies a bucket prefix for your report.
- bucket_
access_ strrole_ arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- s3_
bucket_ strarn - Specifies the ARN of the S3 bucket where Datasync uploads your report.
- subdirectory str
- Specifies a bucket prefix for your report.
- bucket
Access StringRole Arn - Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.
- s3Bucket
Arn 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.
Aws Native. Data Sync. Inputs. Task Report Config Overrides Properties Deleted Properties - 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.
Aws Native. Data Sync. Inputs. Task Report Config Overrides Properties Skipped Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
- Transferred
Pulumi.
Aws Native. Data Sync. Inputs. Task Report Config Overrides Properties Transferred Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
- Verified
Pulumi.
Aws Native. Data Sync. Inputs. Task Report Config Overrides Properties Verified Properties - 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
Task
Report Config Overrides Properties Deleted Properties - 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
Task
Report Config Overrides Properties Skipped Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
- Transferred
Task
Report Config Overrides Properties Transferred Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
- Verified
Task
Report Config Overrides Properties Verified Properties - 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
Task
Report Config Overrides Properties Deleted Properties - 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
Task
Report Config Overrides Properties Skipped Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
- transferred
Task
Report Config Overrides Properties Transferred Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
- verified
Task
Report Config Overrides Properties Verified Properties - 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
Task
Report Config Overrides Properties Deleted Properties - 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
Task
Report Config Overrides Properties Skipped Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
- transferred
Task
Report Config Overrides Properties Transferred Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
- verified
Task
Report Config Overrides Properties Verified Properties - 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
Task
Report Config Overrides Properties Deleted Properties - 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
Task
Report Config Overrides Properties Skipped Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
- transferred
Task
Report Config Overrides Properties Transferred Properties - Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
- verified
Task
Report Config Overrides Properties Verified Properties - 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
- Report
Level Pulumi.Aws Native. Data Sync. Task Report Config Overrides Properties Deleted Properties Report Level - 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 TaskReport Config Overrides Properties Deleted Properties Report Level - 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 TaskReport Config Overrides Properties Deleted Properties Report Level - 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 TaskReport Config Overrides Properties Deleted Properties Report Level - 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 TaskReport Config Overrides Properties Deleted Properties Report Level - 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 "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
- Report
Level Pulumi.Aws Native. Data Sync. Task Report Config Overrides Properties Skipped Properties Report Level - 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 TaskReport Config Overrides Properties Skipped Properties Report Level - 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 TaskReport Config Overrides Properties Skipped Properties Report Level - 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 TaskReport Config Overrides Properties Skipped Properties Report Level - 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 TaskReport Config Overrides Properties Skipped Properties Report Level - 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 "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
- Report
Level Pulumi.Aws Native. Data Sync. Task Report Config Overrides Properties Transferred Properties Report Level - 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 TaskReport Config Overrides Properties Transferred Properties Report Level - 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 TaskReport Config Overrides Properties Transferred Properties Report Level - 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 TaskReport Config Overrides Properties Transferred Properties Report Level - 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 TaskReport Config Overrides Properties Transferred Properties Report Level - 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 "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
- Report
Level Pulumi.Aws Native. Data Sync. Task Report Config Overrides Properties Verified Properties Report Level - 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 TaskReport Config Overrides Properties Verified Properties Report Level - 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 TaskReport Config Overrides Properties Verified Properties Report Level - 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 TaskReport Config Overrides Properties Verified Properties Report Level - 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 TaskReport Config Overrides Properties Verified Properties Report Level - 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 "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
- Schedule
Expression string - A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
- Status
Pulumi.
Aws Native. Data Sync. Task Schedule Status - Specifies status of a schedule.
- Schedule
Expression string - A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
- Status
Task
Schedule Status - Specifies status of a schedule.
- schedule
Expression String - A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
- status
Task
Schedule Status - Specifies status of a schedule.
- schedule
Expression string - A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location
- status
Task
Schedule Status - 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
Task
Schedule Status - Specifies status of a schedule.
- schedule
Expression 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.