class CfnTask (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnTask`
Java	`software.amazon.awscdk.services.datasync.CfnTask`
Python	`aws_cdk.aws_datasync.CfnTask`
TypeScript	`@aws-cdk/aws-datasync` » `CfnTask`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DataSync::Task.

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as datasync from '@aws-cdk/aws-datasync';
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',
  }],
  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',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

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

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnTaskProps — - resource properties.

Create a new AWS::DataSync::Task.

Construct Props

Name	Type	Description
destinationLocationArn	`string`	The Amazon Resource Name (ARN) of an AWS storage resource's location.
sourceLocationArn	`string`	The Amazon Resource Name (ARN) of the source location for the task.
cloudWatchLogGroupArn?	`string`	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
excludes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that exclude specific data during your transfer.
includes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that include specific data during your transfer.
name?	`string`	The name of a task.
options?	`IResolvable` `\|` `OptionsProperty`	Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
schedule?	`IResolvable` `\|` `TaskScheduleProperty`	Specifies a schedule used to periodically transfer files from a source to a destination location.
tags?	`CfnTag[]`	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

destinationLocationArn

Type: string

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

sourceLocationArn

Type: string

The Amazon Resource Name (ARN) of the source location for the task.

cloudWatchLogGroupArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .

excludes?

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

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

includes?

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

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

name?

Type: string (optional)

The name of a task.

This value is a text reference that is used to identify the task in the console.

options?

Type: IResolvable | OptionsProperty (optional)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution ). For more information, see StartTaskExecution .

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

tags?

Type: CfnTag[] (optional)

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

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

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	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
sourceLocationArn	`string`	The Amazon Resource Name (ARN) of the source location for the task.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
cloudWatchLogGroupArn?	`string`	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
excludes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that exclude specific data during your transfer.
includes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that include specific data during your transfer.
name?	`string`	The name of a task.
options?	`IResolvable` `\|` `OptionsProperty`	Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
schedule?	`IResolvable` `\|` `TaskScheduleProperty`	Specifies a schedule used to periodically transfer files from a source to a destination location.
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: ConstructNode

The construct tree node associated with this construct.

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

The Amazon Resource Name (ARN) of the source location for the task.

stack

Type: Stack

The stack in which this element is defined.

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

cloudWatchLogGroupArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .

excludes?

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

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

includes?

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

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

name?

Type: string (optional)

The name of a task.

This value is a text reference that is used to identify the task in the console.

options?

Type: IResolvable | OptionsProperty (optional)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution ). For more information, see StartTaskExecution .

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

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)`.
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)	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.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
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).

addDependsOn(target)

public addDependsOn(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.

addMetadata(key, value)

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

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

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.

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.

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.

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 }