Class CfnTask

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnTask
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTask : CfnResource, IInspectable, ITaskRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnTask Inherits CfnResource Implements IInspectable, ITaskRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataSync;

             var cfnTask = new CfnTask(this, "MyCfnTask", new CfnTaskProps {
                 DestinationLocationArn = "destinationLocationArn",
                 SourceLocationArn = "sourceLocationArn",

                 // the properties below are optional
                 CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
                 Excludes = new [] { new FilterRuleProperty {
                     FilterType = "filterType",
                     Value = "value"
                 } },
                 Includes = new [] { new FilterRuleProperty {
                     FilterType = "filterType",
                     Value = "value"
                 } },
                 ManifestConfig = new ManifestConfigProperty {
                     Source = new SourceProperty {
                         S3 = new ManifestConfigSourceS3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             ManifestObjectPath = "manifestObjectPath",
                             ManifestObjectVersionId = "manifestObjectVersionId",
                             S3BucketArn = "s3BucketArn"
                         }
                     },

                     // the properties below are optional
                     Action = "action",
                     Format = "format"
                 },
                 Name = "name",
                 Options = new OptionsProperty {
                     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 = new TaskScheduleProperty {
                     ScheduleExpression = "scheduleExpression",
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TaskMode = "taskMode",
                 TaskReportConfig = new TaskReportConfigProperty {
                     Destination = new DestinationProperty {
                         S3 = new S3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             S3BucketArn = "s3BucketArn",
                             Subdirectory = "subdirectory"
                         }
                     },
                     OutputType = "outputType",

                     // the properties below are optional
                     ObjectVersionIds = "objectVersionIds",
                     Overrides = new OverridesProperty {
                         Deleted = new DeletedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Skipped = new SkippedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Transferred = new TransferredProperty {
                             ReportLevel = "reportLevel"
                         },
                         Verified = new VerifiedProperty {
                             ReportLevel = "reportLevel"
                         }
                     },
                     ReportLevel = "reportLevel"
                 }
             });

Synopsis

Constructors

CfnTask(Construct, string, ICfnTaskProps)

Create a new AWS::DataSync::Task.

Properties

AttrDestinationNetworkInterfaceArns

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

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

The status of the task that was described.
AttrTaskArn

The ARN of the task.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

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

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

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

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

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

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

Specifies the name of your task.
Options

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

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

Specifies the ARN of your transfer's source location.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

The task mode that you're using.
TaskRef

A reference to a Task resource.
TaskReportConfig

The configuration of your task report, which provides detailed information about your DataSync transfer.

Methods

ArnForTask(ITaskRef)

The AWS::DataSync::Task resource specifies a task.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnTask(object)

Checks whether the given object is a CfnTask.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnTask(Construct, string, ICfnTaskProps)

Create a new AWS::DataSync::Task.

public CfnTask(Construct scope, string id, ICfnTaskProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnTaskProps

Resource properties.

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Properties

AttrDestinationNetworkInterfaceArns

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

public virtual string[] AttrDestinationNetworkInterfaceArns { get; }
Property Value

string[]

Remarks

CloudformationAttribute: DestinationNetworkInterfaceArns

AttrSourceNetworkInterfaceArns

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

public virtual string[] AttrSourceNetworkInterfaceArns { get; }
Property Value

string[]

Remarks

CloudformationAttribute: SourceNetworkInterfaceArns

AttrStatus

The status of the task that was described.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

AttrTaskArn

The ARN of the task.

public virtual string AttrTaskArn { get; }
Property Value

string

Remarks

CloudformationAttribute: TaskArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

CloudWatchLogGroupArn

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

public virtual string? CloudWatchLogGroupArn { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

DestinationLocationArn

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

public virtual string DestinationLocationArn { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Excludes

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

public virtual object? Excludes { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnTask.IFilterRuleProperty)[]

Includes

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

public virtual object? Includes { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnTask.IFilterRuleProperty)[]

ManifestConfig

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

public virtual object? ManifestConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTask.IManifestConfigProperty

Name

Specifies the name of your task.

public virtual string? Name { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Options

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

public virtual object? Options { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTask.IOptionsProperty

Schedule

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

public virtual object? Schedule { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTask.ITaskScheduleProperty

SourceLocationArn

Specifies the ARN of your transfer's source location.

public virtual string SourceLocationArn { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

TaskMode

The task mode that you're using.

public virtual string? TaskMode { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

TaskRef

A reference to a Task resource.

public virtual ITaskReference TaskRef { get; }
Property Value

ITaskReference

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

TaskReportConfig

The configuration of your task report, which provides detailed information about your DataSync transfer.

public virtual object? TaskReportConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTask.ITaskReportConfigProperty

Methods

ArnForTask(ITaskRef)

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

public static string ArnForTask(ITaskRef resource)
Parameters
resource ITaskRef
Returns

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataSync;

             var cfnTask = new CfnTask(this, "MyCfnTask", new CfnTaskProps {
                 DestinationLocationArn = "destinationLocationArn",
                 SourceLocationArn = "sourceLocationArn",

                 // the properties below are optional
                 CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
                 Excludes = new [] { new FilterRuleProperty {
                     FilterType = "filterType",
                     Value = "value"
                 } },
                 Includes = new [] { new FilterRuleProperty {
                     FilterType = "filterType",
                     Value = "value"
                 } },
                 ManifestConfig = new ManifestConfigProperty {
                     Source = new SourceProperty {
                         S3 = new ManifestConfigSourceS3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             ManifestObjectPath = "manifestObjectPath",
                             ManifestObjectVersionId = "manifestObjectVersionId",
                             S3BucketArn = "s3BucketArn"
                         }
                     },

                     // the properties below are optional
                     Action = "action",
                     Format = "format"
                 },
                 Name = "name",
                 Options = new OptionsProperty {
                     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 = new TaskScheduleProperty {
                     ScheduleExpression = "scheduleExpression",
                     Status = "status"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TaskMode = "taskMode",
                 TaskReportConfig = new TaskReportConfigProperty {
                     Destination = new DestinationProperty {
                         S3 = new S3Property {
                             BucketAccessRoleArn = "bucketAccessRoleArn",
                             S3BucketArn = "s3BucketArn",
                             Subdirectory = "subdirectory"
                         }
                     },
                     OutputType = "outputType",

                     // the properties below are optional
                     ObjectVersionIds = "objectVersionIds",
                     Overrides = new OverridesProperty {
                         Deleted = new DeletedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Skipped = new SkippedProperty {
                             ReportLevel = "reportLevel"
                         },
                         Transferred = new TransferredProperty {
                             ReportLevel = "reportLevel"
                         },
                         Verified = new VerifiedProperty {
                             ReportLevel = "reportLevel"
                         }
                     },
                     ReportLevel = "reportLevel"
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

IsCfnTask(object)

Checks whether the given object is a CfnTask.

public static bool IsCfnTask(object x)
Parameters
x object
Returns

bool

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html

CloudformationResource: AWS::DataSync::Task

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable