awscc.datasync_task¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - datasync:DeleteTask, ec2:DeleteNetworkInterface, ec2:DescribeSecurityGroups, ec2:DescribeSubnets, fsx:DescribeFileSystems, elasticfilesystem:DescribeFileSystems, elasticfilesystem:DescribeMountTargets, iam:GetRole
update¶
Parent base class for filters and actions.
definitions:
DestinationNetworkInterfaceArns:
description: The Amazon Resource Names (ARNs) of the destination ENIs (Elastic
Network Interfaces) that were created for your subnet.
insertionOrder: false
items:
pattern: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$
type: string
maxItems: 128
type: array
FilterRule:
additionalProperties: false
description: Specifies which files folders and objects to include or exclude when
transferring files from source to destination.
properties:
FilterType:
description: The type of filter rule to apply. AWS DataSync only supports
the SIMPLE_PATTERN rule type.
enum:
- SIMPLE_PATTERN
maxLength: 128
pattern: ^[A-Z0-9_]+$
type: string
Value:
description: A single filter string that consists of the patterns to include
or exclude. The patterns are delimited by "|".
maxLength: 409600
pattern: ^[^\x00]+$
type: string
type: object
Options:
additionalProperties: false
description: Represents the options that are available to control the behavior
of a StartTaskExecution operation.
properties:
Atime:
description: A file metadata value that shows the last time a file was accessed
(that is, when the file was read or written to).
enum:
- NONE
- BEST_EFFORT
type: string
BytesPerSecond:
description: A value that limits the bandwidth used by AWS DataSync.
format: int64
minimum: -1
type: integer
Gid:
description: The group ID (GID) of the file's owners.
enum:
- NONE
- INT_VALUE
- NAME
- BOTH
type: string
LogLevel:
description: A value that determines the types of logs that DataSync publishes
to a log stream in the Amazon CloudWatch log group that you provide.
enum:
- 'OFF'
- BASIC
- TRANSFER
type: string
Mtime:
description: A value that indicates the last time that a file was modified
(that is, a file was written to) before the PREPARING phase.
enum:
- NONE
- PRESERVE
type: string
OverwriteMode:
description: A value that determines whether files at the destination should
be overwritten or preserved when copying files.
enum:
- ALWAYS
- NEVER
type: string
PosixPermissions:
description: 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.
enum:
- NONE
- PRESERVE
type: string
PreserveDeletedFiles:
description: A value that specifies whether files in the destination that
don't exist in the source file system should be preserved.
enum:
- PRESERVE
- REMOVE
type: string
PreserveDevices:
description: 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.
enum:
- NONE
- PRESERVE
type: string
SecurityDescriptorCopyFlags:
description: A value that determines which components of the SMB security
descriptor are copied during transfer.
enum:
- NONE
- OWNER_DACL
- OWNER_DACL_SACL
type: string
TaskQueueing:
description: A value that determines whether tasks should be queued before
executing the tasks.
enum:
- ENABLED
- DISABLED
type: string
TransferMode:
description: 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.
enum:
- CHANGED
- ALL
type: string
Uid:
description: The user ID (UID) of the file's owner.
enum:
- NONE
- INT_VALUE
- NAME
- BOTH
type: string
VerifyMode:
description: 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.
enum:
- POINT_IN_TIME_CONSISTENT
- ONLY_FILES_TRANSFERRED
- NONE
type: string
type: object
SourceNetworkInterfaceArns:
description: The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network
Interfaces) that were created for your subnet.
insertionOrder: false
items:
pattern: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$
type: string
maxItems: 128
type: array
Tag:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: The key for an AWS resource tag.
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\s+=._:/-]+$
type: string
Value:
description: The value for an AWS resource tag.
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\s+=._:@/-]+$
type: string
required:
- Key
- Value
type: object
TaskSchedule:
additionalProperties: false
description: Specifies the schedule you want your task to use for repeated executions.
properties:
ScheduleExpression:
description: A cron expression that specifies when AWS DataSync initiates
a scheduled transfer from a source to a destination location
maxLength: 256
pattern: ^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$
type: string
required:
- ScheduleExpression
type: object
properties:
CloudWatchLogGroupArn:
description: The ARN of the Amazon CloudWatch log group that is used to monitor
and log events in the task.
maxLength: 562
pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$
type: string
Excludes:
insertionOrder: false
items:
additionalProperties: false
description: Specifies which files folders and objects to include or exclude
when transferring files from source to destination.
properties:
FilterType:
description: The type of filter rule to apply. AWS DataSync only supports
the SIMPLE_PATTERN rule type.
enum:
- SIMPLE_PATTERN
maxLength: 128
pattern: ^[A-Z0-9_]+$
type: string
Value:
description: A single filter string that consists of the patterns to include
or exclude. The patterns are delimited by "|".
maxLength: 409600
pattern: ^[^\x00]+$
type: string
type: object
maxItems: 1
minItems: 0
type: array
Includes:
insertionOrder: false
items:
additionalProperties: false
description: Specifies which files folders and objects to include or exclude
when transferring files from source to destination.
properties:
FilterType:
description: The type of filter rule to apply. AWS DataSync only supports
the SIMPLE_PATTERN rule type.
enum:
- SIMPLE_PATTERN
maxLength: 128
pattern: ^[A-Z0-9_]+$
type: string
Value:
description: A single filter string that consists of the patterns to include
or exclude. The patterns are delimited by "|".
maxLength: 409600
pattern: ^[^\x00]+$
type: string
type: object
maxItems: 1
minItems: 0
type: array
Name:
description: The name of a task. This value is a text reference that is used to
identify the task in the console.
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\s+=._:@/-]+$
type: string
Options:
additionalProperties: false
description: Represents the options that are available to control the behavior
of a StartTaskExecution operation.
properties:
Atime:
description: A file metadata value that shows the last time a file was accessed
(that is, when the file was read or written to).
enum:
- NONE
- BEST_EFFORT
type: string
BytesPerSecond:
description: A value that limits the bandwidth used by AWS DataSync.
format: int64
minimum: -1
type: integer
Gid:
description: The group ID (GID) of the file's owners.
enum:
- NONE
- INT_VALUE
- NAME
- BOTH
type: string
LogLevel:
description: A value that determines the types of logs that DataSync publishes
to a log stream in the Amazon CloudWatch log group that you provide.
enum:
- 'OFF'
- BASIC
- TRANSFER
type: string
Mtime:
description: A value that indicates the last time that a file was modified
(that is, a file was written to) before the PREPARING phase.
enum:
- NONE
- PRESERVE
type: string
OverwriteMode:
description: A value that determines whether files at the destination should
be overwritten or preserved when copying files.
enum:
- ALWAYS
- NEVER
type: string
PosixPermissions:
description: 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.
enum:
- NONE
- PRESERVE
type: string
PreserveDeletedFiles:
description: A value that specifies whether files in the destination that
don't exist in the source file system should be preserved.
enum:
- PRESERVE
- REMOVE
type: string
PreserveDevices:
description: 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.
enum:
- NONE
- PRESERVE
type: string
SecurityDescriptorCopyFlags:
description: A value that determines which components of the SMB security
descriptor are copied during transfer.
enum:
- NONE
- OWNER_DACL
- OWNER_DACL_SACL
type: string
TaskQueueing:
description: A value that determines whether tasks should be queued before
executing the tasks.
enum:
- ENABLED
- DISABLED
type: string
TransferMode:
description: 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.
enum:
- CHANGED
- ALL
type: string
Uid:
description: The user ID (UID) of the file's owner.
enum:
- NONE
- INT_VALUE
- NAME
- BOTH
type: string
VerifyMode:
description: 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.
enum:
- POINT_IN_TIME_CONSISTENT
- ONLY_FILES_TRANSFERRED
- NONE
type: string
type: object
Schedule:
additionalProperties: false
description: Specifies the schedule you want your task to use for repeated executions.
properties:
ScheduleExpression:
description: A cron expression that specifies when AWS DataSync initiates
a scheduled transfer from a source to a destination location
maxLength: 256
pattern: ^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$
type: string
required:
- ScheduleExpression
type: object
Tags:
description: An array of key-value pairs to apply to this resource.
insertionOrder: false
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: The key for an AWS resource tag.
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\s+=._:/-]+$
type: string
Value:
description: The value for an AWS resource tag.
maxLength: 256
minLength: 1
pattern: ^[a-zA-Z0-9\s+=._:@/-]+$
type: string
required:
- Key
- Value
type: object
maxItems: 50
type: array
uniqueItems: true
type:
enum:
- update
Permissions - datasync:UpdateTask, datasync:DescribeTask, datasync:ListTagsForResource, datasync:TagResource, datasync:UntagResource, logs:DescribeLogGroups