AWS Native v0.54.0, Mar 21 23

aws-native.datasync.getTask

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:

TaskArn string: The ARN of the task.

TaskArn string: The ARN of the task.

taskArn String: The ARN of the task.

taskArn string: The ARN of the task.

task_arn str: The ARN of the task.

taskArn 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>
Excludes List<Pulumi.AwsNative.DataSync.Outputs.TaskFilterRule>
Includes List<Pulumi.AwsNative.DataSync.Outputs.TaskFilterRule>
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
Schedule Pulumi.AwsNative.DataSync.Outputs.TaskSchedule
SourceNetworkInterfaceArns List<string>
Status Pulumi.AwsNative.DataSync.TaskStatus: The status of the task that was described.
Tags List<Pulumi.AwsNative.DataSync.Outputs.TaskTag>: An array of key-value pairs to apply to this resource.
TaskArn string: The ARN of the task.

CloudWatchLogGroupArn string: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationNetworkInterfaceArns []string
Excludes []TaskFilterRule
Includes []TaskFilterRule
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
Schedule TaskSchedule
SourceNetworkInterfaceArns []string
Status TaskStatus: The status of the task that was described.
Tags []TaskTag: An array of key-value pairs to apply to this resource.
TaskArn string: The ARN of the task.

cloudWatchLogGroupArn String: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns List<String>
excludes List<TaskFilterRule>
includes List<TaskFilterRule>
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
schedule TaskSchedule
sourceNetworkInterfaceArns List<String>
status TaskStatus: The status of the task that was described.
tags List<TaskTag>: An array of key-value pairs to apply to this resource.
taskArn String: The ARN of the task.

cloudWatchLogGroupArn string: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns string[]
excludes TaskFilterRule[]
includes TaskFilterRule[]
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
schedule TaskSchedule
sourceNetworkInterfaceArns string[]
status TaskStatus: The status of the task that was described.
tags TaskTag[]: An array of key-value pairs to apply to this resource.
taskArn string: The ARN of the task.

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]
excludes Sequence[TaskFilterRule]
includes Sequence[TaskFilterRule]
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
schedule TaskSchedule
source_network_interface_arns Sequence[str]
status TaskStatus: The status of the task that was described.
tags Sequence[TaskTag]: An array of key-value pairs to apply to this resource.
task_arn str: The ARN of the task.

cloudWatchLogGroupArn String: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destinationNetworkInterfaceArns List<String>
excludes List<Property Map>
includes List<Property Map>
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
schedule Property Map
sourceNetworkInterfaceArns List<String>
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.

Supporting Types

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

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

TaskSchedule

ScheduleExpression string: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

ScheduleExpression string: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

scheduleExpression String: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

scheduleExpression string: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

schedule_expression str: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

scheduleExpression String: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

TaskStatus

TaskTag

Key string: The key for an AWS resource tag.
Value string: The value for an AWS resource tag.

Key string: The key for an AWS resource tag.
Value string: The value for an AWS resource tag.

key String: The key for an AWS resource tag.
value String: The value for an AWS resource tag.

key string: The key for an AWS resource tag.
value string: The value for an AWS resource tag.

key str: The key for an AWS resource tag.
value str: The value for an AWS resource tag.

key String: The key for an AWS resource tag.
value String: The value for an AWS resource tag.

Package Details

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