class CfnTask (construct)

Language	Type name
.NET	Amazon.CDK.AWS.DataSync.CfnTask
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnTask
Java	software.amazon.awscdk.services.datasync.CfnTask
Python	aws_cdk.aws_datasync.CfnTask
TypeScript	aws-cdk-lib » aws_datasync » CfnTask

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::DataSync::Task resource specifies a task.

A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnTask = new datasync.CfnTask(this, 'MyCfnTask', {
  destinationLocationArn: 'destinationLocationArn',
  sourceLocationArn: 'sourceLocationArn',

  // the properties below are optional
  cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
  excludes: [{
    filterType: 'filterType',
    value: 'value',
  }],
  includes: [{
    filterType: 'filterType',
    value: 'value',
  }],
  manifestConfig: {
    source: {
      s3: {
        bucketAccessRoleArn: 'bucketAccessRoleArn',
        manifestObjectPath: 'manifestObjectPath',
        manifestObjectVersionId: 'manifestObjectVersionId',
        s3BucketArn: 's3BucketArn',
      },
    },

    // the properties below are optional
    action: 'action',
    format: 'format',
  },
  name: 'name',
  options: {
    atime: 'atime',
    bytesPerSecond: 123,
    gid: 'gid',
    logLevel: 'logLevel',
    mtime: 'mtime',
    objectTags: 'objectTags',
    overwriteMode: 'overwriteMode',
    posixPermissions: 'posixPermissions',
    preserveDeletedFiles: 'preserveDeletedFiles',
    preserveDevices: 'preserveDevices',
    securityDescriptorCopyFlags: 'securityDescriptorCopyFlags',
    taskQueueing: 'taskQueueing',
    transferMode: 'transferMode',
    uid: 'uid',
    verifyMode: 'verifyMode',
  },
  schedule: {
    scheduleExpression: 'scheduleExpression',
    status: 'status',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskMode: 'taskMode',
  taskReportConfig: {
    destination: {
      s3: {
        bucketAccessRoleArn: 'bucketAccessRoleArn',
        s3BucketArn: 's3BucketArn',
        subdirectory: 'subdirectory',
      },
    },
    outputType: 'outputType',

    // the properties below are optional
    objectVersionIds: 'objectVersionIds',
    overrides: {
      deleted: {
        reportLevel: 'reportLevel',
      },
      skipped: {
        reportLevel: 'reportLevel',
      },
      transferred: {
        reportLevel: 'reportLevel',
      },
      verified: {
        reportLevel: 'reportLevel',
      },
    },
    reportLevel: 'reportLevel',
  },
});

Initializer

new CfnTask(scope: Construct, id: string, props: CfnTaskProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnTaskProps — Resource properties.

Construct Props

Name	Type	Description
destinationLocationArn	string	The Amazon Resource Name (ARN) of an AWS storage resource's location.
sourceLocationArn	string	Specifies the ARN of your transfer's source location.
cloudWatchLogGroupArn?	string	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
excludes?	IResolvable | IResolvable | FilterRuleProperty[]	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
includes?	IResolvable | IResolvable | FilterRuleProperty[]	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
manifestConfig?	IResolvable | ManifestConfigProperty	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
name?	string	Specifies the name of your task.
options?	IResolvable | OptionsProperty	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule?	IResolvable | TaskScheduleProperty	Specifies a schedule for when you want your task to run.
tags?	CfnTag[]	Specifies the tags that you want to apply to your task.
taskMode?	string	Specifies one of the following task modes for your data transfer:.
taskReportConfig?	IResolvable | TaskReportConfigProperty	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

---

destinationLocationArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-destinationlocationarn

---

sourceLocationArn

Type: string

Specifies the ARN of your transfer's source location.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-sourcelocationarn

---

cloudWatchLogGroupArn?

Type: string (optional)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync .

For more information, see Monitoring data transfers with CloudWatch Logs .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-cloudwatchloggrouparn

---

excludes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-excludes

---

includes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-includes

---

manifestConfig?

Type: IResolvable | ManifestConfigProperty (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-manifestconfig

---

name?

Type: string (optional)

Specifies the name of your task.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-name

---

options?

Type: IResolvable | OptionsProperty (optional)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-options

---

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule for when you want your task to run.

For more information, see Scheduling your task .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-schedule

---

tags?

Type: CfnTag[] (optional)

Specifies the tags that you want to apply to your task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-tags

---

taskMode?

Type: string (optional)

Specifies one of the following task modes for your data transfer:.

• ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

• BASIC (default) - Transfer files or objects between AWS storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

For more information, see Understanding task mode differences .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskmode

---

taskReportConfig?

Type: IResolvable | TaskReportConfigProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig

Properties

Name	Type	Description
attrDestinationNetworkInterfaceArns	string[]	The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.
attrSourceNetworkInterfaceArns	string[]	The ARNs of the source ENIs that were created for your subnet.
attrStatus	string	The status of the task that was described.
attrTaskArn	string	The ARN of the task.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
destinationLocationArn	string	The Amazon Resource Name (ARN) of an AWS storage resource's location.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
sourceLocationArn	string	Specifies the ARN of your transfer's source location.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
cloudWatchLogGroupArn?	string	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
excludes?	IResolvable | IResolvable | FilterRuleProperty[]	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
includes?	IResolvable | IResolvable | FilterRuleProperty[]	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
manifestConfig?	IResolvable | ManifestConfigProperty	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
name?	string	Specifies the name of your task.
options?	IResolvable | OptionsProperty	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule?	IResolvable | TaskScheduleProperty	Specifies a schedule for when you want your task to run.
tagsRaw?	CfnTag[]	Specifies the tags that you want to apply to your task.
taskMode?	string	Specifies one of the following task modes for your data transfer:.
taskReportConfig?	IResolvable | TaskReportConfigProperty	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrDestinationNetworkInterfaceArns

Type: string[]

The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.

---

attrSourceNetworkInterfaceArns

Type: string[]

The ARNs of the source ENIs that were created for your subnet.

---

attrStatus

Type: string

The status of the task that was described.

---

attrTaskArn

Type: string

The ARN of the task.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

destinationLocationArn

Type: string

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

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

sourceLocationArn

Type: string

Specifies the ARN of your transfer's source location.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

cloudWatchLogGroupArn?

Type: string (optional)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

---

excludes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

---

includes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

---

manifestConfig?

Type: IResolvable | ManifestConfigProperty (optional)

The configuration of the manifest that lists the files or objects that you want DataSync to transfer.

---

name?

Type: string (optional)

Specifies the name of your task.

---

options?

Type: IResolvable | OptionsProperty (optional)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

---

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule for when you want your task to run.

---

tagsRaw?

Type: CfnTag[] (optional)

Specifies the tags that you want to apply to your task.

---

taskMode?

Type: string (optional)

Specifies one of the following task modes for your data transfer:.

---

taskReportConfig?

Type: IResolvable | TaskReportConfigProperty (optional)

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }